ar_set_storage_mode

short ar_set_storage_mode (short board, short mode);

Purpose

This function is designed to provide compatibility with legacy ARINC 429 products.  CEI-x30 devices are capable of logging received messages in individual channel buffers or a merged receive buffer on a channel-by-channel basis.  This routine allows you to perform a single invocation to select the universal receive mode for all receive channels on the device as BUFFERED or MERGED.  When a channel storage mode is set for BUFFERED, each receiver is assigned an independent circular buffer for data storage.  When a channel storage mode is set for MERGED, messages received on that channel is stored in the merged receive buffer, with messages received on individual channels logged in order based on the point in time they are received.  Each Receive Data Processing API function handles the respective channel active storage mode internally, acquiring data from the appropriate buffer as necessary.

The routine ar_set_device_config is the recommended routine for manipulating receive channel merged mode operation.  

Parameters

Input

Name

Type

Description

board

short

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

mode

short

(input) Assigns the current state of the API-managed global Individual/Merged buffer storage mode feature:
ARU_BUFFERED (0) all device reception will use individual channel buffers
ARU_MERGED   (2) all device reception will use the merged buffer    

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_NORMAL                  Success.
ARS_INVBOARD              The board parameter value was invalid.
ARS_INVARG                  The mode parameter value was invalid.
ARS_BOARD_MUTEX        Access to the Board Lock timed-out/failed.

References

Utility Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description