ar_getnext_xt

short ar_getnext_xt (short board, short channel, unsigned int * destination, AR_TIMETAG_TYPE * timeTagRef);

Purpose

This function retrieves the most stale unread message and time-tag from the specified receive channel.  If no data is present in the receiver FIFO 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.

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.

Output

 

 

Name

Type

Description

destination

unsigned int (passed by reference)

(output) The received ARINC 429 message.

timeTagRef

AR_TIMETAG_TYPE (passed by reference)

(output) The time-tag data structure associated with the data.  Defined as follows:
typedef struct {
    TIME_TAG_TYPE timeTagFormat;        The format of the corresponding timeTag member.
    TIME_TAG_TYPE timeTag;                  The time-tag value, format specified via timeTagFormat member.
    TIME_TAG_TYPE referenceTimeTag;    The time-tag value in 64-bit 1 microsecond format.
};

Return Value

Name

Type

Description

status

short

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

ARS_INVARG            The destination parameter reference was NULL.

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

ARS_BAD_MESSAGE  An invalid length ARINC 429 message was detected.

References

Receive Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description