Synergy Software Package User's Manual

RTOS-integrated Messaging Framework Interface. More...

Data Structures

struct  sf_message_header_t
 
struct  sf_message_instance_range_t
 
struct  sf_message_subscriber_t
 
struct  sf_message_subscriber_list_t
 
struct  sf_message_callback_args_t
 
struct  sf_message_post_err_t
 
struct  sf_message_buffer_ctrl_t
 Buffer control block structure. More...
 
struct  sf_message_cfg_t
 
struct  sf_message_acquire_cfg_t
 
struct  sf_message_post_cfg_t
 
struct  sf_message_api_t
 
struct  sf_message_instance_t
 

Macros

#define SF_MESSAGE_API_VERSION_MAJOR   (2U)
 

Typedefs

typedef void sf_message_ctrl_t
 

Enumerations

enum  sf_message_state_t { SF_MESSAGE_STATE_CLOSED = 0, SF_MESSAGE_STATE_OPENED }
 
enum  sf_message_callback_event_t { SF_MESSAGE_CALLBACK_EVENT_ACK = 0, SF_MESSAGE_CALLBACK_EVENT_NAK }
 
enum  sf_message_priority_t { SF_MESSAGE_PRIORITY_NORMAL = 0, SF_MESSAGE_PRIORITY_HIGH }
 
enum  sf_message_release_option_t { SF_MESSAGE_RELEASE_OPTION_NONE = 0, SF_MESSAGE_RELEASE_OPTION_FORCED_RELEASE = 1, SF_MESSAGE_RELEASE_OPTION_ACK = 2, SF_MESSAGE_RELEASE_OPTION_NAK = 4 }
 

Detailed Description

RTOS-integrated Messaging Framework Interface.

Summary

This module is a ThreadX-aware Messaging Framework. This Interface is implemented by Messaging Framework.

Related SSP architecture topics:

Messaging Interface description: Messaging Framework

Macro Definition Documentation

◆ SF_MESSAGE_API_VERSION_MAJOR

#define SF_MESSAGE_API_VERSION_MAJOR   (2U)

Version of the API defined in this file

Typedef Documentation

◆ sf_message_ctrl_t

typedef void sf_message_ctrl_t

Message framework control block. Allocate an instance specific control block to pass into the message framework API calls.

Implemented as

Enumeration Type Documentation

◆ sf_message_callback_event_t

Messaging callback response

Enumerator
SF_MESSAGE_CALLBACK_EVENT_ACK 

ACK response.

SF_MESSAGE_CALLBACK_EVENT_NAK 

NAK response.

◆ sf_message_priority_t

Messaging framework state

Enumerator
SF_MESSAGE_PRIORITY_NORMAL 

Gives a message to be sent normal priority.

SF_MESSAGE_PRIORITY_HIGH 

Gives a message to be sent higher priority than previous ones.

◆ sf_message_release_option_t

Messaging option

Enumerator
SF_MESSAGE_RELEASE_OPTION_NONE 

No option.

SF_MESSAGE_RELEASE_OPTION_FORCED_RELEASE 

Buffer forced release option.

SF_MESSAGE_RELEASE_OPTION_ACK 

ACK response (note if both ACK and NAK are set at same time, NAK.

SF_MESSAGE_RELEASE_OPTION_NAK 

NAK response.

◆ sf_message_state_t

Messaging framework state

Enumerator
SF_MESSAGE_STATE_CLOSED 

Messaging framework is closed.

SF_MESSAGE_STATE_OPENED 

Messaging framework is opened.