Application Message Service. More...

Topics
	Referred Types
	Referred types used by Application Message Service.

Data Structures
struct	Ucs_Ams_InitData_t
	The initialization data of the Application Message Service. More...

Macros
#define	UCS_AMS_NUM_RX_MSGS 20
	Defines the number of reserved Rx message objects. Valid values: 5..255. Default value: 20.

#define	UCS_AMS_SIZE_RX_MSG 45
	Defines the payload size in bytes which is available for every Rx message object. Valid values: 45..65535. Default value: 45.

#define	UCS_AMS_NUM_TX_MSGS 20
	Defines the number of reserved Tx message objects. Valid values: 5..255. Default value: 20.

#define	UCS_AMS_SIZE_TX_MSG 45
	Defines the payload size in bytes which is available for every Tx message object. Valid values: 45..65535. Default value: 45.

Callback Functions
typedef void(*	Ucs_AmsTx_MsgFreedCb_t )(void *user_ptr)
	Type of a callback function that is invoked to notify that a Tx application message object is available again while a previous allocation using Ucs_AmsTx_AllocMsg() has failed.

typedef void(*	Ucs_AmsRx_MsgReceivedCb_t )(void *user_ptr)
	Callback function type that is invoked if UNICENS has received a message completely and appended to the Rx message queue.

Functions
Ucs_AmsTx_Msg_t *	Ucs_AmsTx_AllocMsg (Ucs_Inst_t *self, uint16_t data_size)
	Allocates an application message object for transmission.

Ucs_Return_t	Ucs_AmsTx_SendMsg (Ucs_Inst_t self, Ucs_AmsTx_Msg_t msg_ptr, Ucs_AmsTx_CompleteCb_t tx_complete_fptr)
	Transmits an application message.

void	Ucs_AmsTx_FreeUnusedMsg (Ucs_Inst_t self, Ucs_AmsTx_Msg_t msg_ptr)
	Frees an unused Tx message object.

Ucs_AmsRx_Msg_t *	Ucs_AmsRx_PeekMsg (Ucs_Inst_t *self)
	Retrieves a reference to the front-most message in the Rx queue.

void	Ucs_AmsRx_ReleaseMsg (Ucs_Inst_t *self)
	Removes and frees the front-most message from the Rx queue.

uint16_t	Ucs_AmsRx_GetMsgCnt (Ucs_Inst_t *self)
	Retrieves the number of messages that are located in the Rx queue.

Detailed Description

Application Message Service.

Topics