ar_get_429_message

short ar_get_429_message (short board, short channel, short waitState, void * data, void * timeTag);

Purpose

This function retrieves the most stale unread ARINC 429 message and 32-bit time-tag from the specified channel receive buffer.  If "wait" is specified and no messages are present in the receiver buffer, this function attempts to retrieve data for up to one-half second.  If no data is present after one-half second, a time-out status is returned. If "no wait" is specified and no data is available, the return status will indicate “no data”.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number of the board to reference, (valid range is 0-15).

channel

short

(input) Specifies which receive channel this routine is to access.  Valid range is 0 to one less than the installed ARINC 429 receive channel count.

waitState

short

(input) Specifies whether or not to wait for 1/2 second for data to be received if no data is available in the receiver FIFO on invocation.
AR_ON  (7) specifies to wait 1/2 second for data
AR_OFF (8) specifies to return immediately if no data is available

Output

 

 

Name

Type

Description

data

any type (passed by reference)

(output) The received ARINC 429 message.

timeTag

any type (passed by reference)

(output) The time-tag associated with the received ARINC 429 message, (resolution is based on the current programmed timer reference).  

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_GOTDATA          Success - data returned.
ARS_NODATA            No data was available if waitState was AR_OFF.
ARS_CHAN_TIMEOUT No data was available if waitState was AR_ON.
ARS_INVBOARD        The board parameter value was invalid.
ARS_INVHARVAL       The channel parameter was not valid for this device configuration.

ARS_INVARG            The data parameter reference was NULL.

ARS_BOARD_MUTEX  Access to the Board Lock timed-out/failed.

ARS_BAD_MESSAGE  Reception of an invalid length ARINC 429 message was detected.

References

Receive Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description