ar_define_msg_block

short ar_define_msg_block (int numberOfEntries, AR_SCHEDULED_MSG_ENTRY_TYPE * messageEntry);

Purpose

This function defines a block of 32-bit ARINC 429 messages for periodic retransmission at the specified rates.  Once defined, the message rate, content, or assigned channel may be altered via invocation of ar_modify_msg_block.  You may use ar_modify_msg to modify the message; however, the preferred method is ar_modify_msg_block.

Parameters

Input

Name

Type

Description

numberOfEntries

int

(input) The number of entries to define, used as a reference for the number of structure array elements defined in the messageEntry array.

Input/Output

 

 

Name

Type

Description

messageEntry

AR_SCHEDULED_MSG_ENTRY_TYPE (passed by reference)

(input/output) An array of structures of message definition, each element defined as follows:

struct {                 
     unsigned int messageIndex;   
     unsigned int board;          
     unsigned int channel;        
     unsigned int rate;           
     unsigned int start;          
     unsigned int txCount;
     unsigned int data;
}


messageIndex
This structure member is the only item treated as an output from this function, in that it is overwritten with the unique message scheduler table entry index assigned to this message.

board
The device to access.  Valid range is 0-15.

channel
The transmit channel to reference.  The valid range is 0 to one less than the installed ARINC 429 transmit channel count.

rate
The periodic transmission rate, defined in milliseconds.

start
The offset, (in milliseconds), from the start of CEI-x30 device message processing at which this message will begin its initial periodic transmission.

txCount
The total number of times this message will be transmitted (0xFFFFFFFF indicates infinite transmission of this message is desired).

data
The 32-bit ARINC message to transmit.

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_NORMAL            Success.
ARS_INVBOARD        Invalid or uninitialized board.
ARS_INVARG            Invalid numberOfEntries parameter value.
ARS_INVHARVAL       Invalid transmit channel entry.
ARS_BOARD_MUTEX Access to the Board Lock timed-out/failed.
ARS_FAILURE           Message scheduler table full indication.

References

Transmit Data Processing Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description