Home FAQ Player Stage Gazebo Contrib Documentation Publications Contributors Users Project Download Bugs/Feedback Mailing lists Radish Old news Old stuff

mcom [Interfaces] Detailed Description The mcom interface is designed for exchanging information between clients. A client sends a message of a given "type" and "channel". This device stores adds the message to that channel's stack. A second client can then request data of a given "type" and "channel". Push, Pop, Read, and Clear operations are defined, but their semantics can vary, based on the stack discipline of the underlying driver. For example, the lifomcom driver enforces a last-in-first-out stack. This interface returns no data and accepts no commands. Classes struct   player_mcom_data   A piece of data. More... struct   player_mcom_config   Configuration request: Config requests sent to server. More... struct   player_mcom_return   Configuration reply from server. More... Defines #define  MCOM_DATA_LEN   128 #define  MCOM_COMMAND_BUFFER_SIZE   (sizeof(player_mcom_config_t)) #define  MCOM_DATA_BUFFER_SIZE   0 #define  MCOM_N_BUFS   10 #define  MCOM_CHANNEL_LEN   8 #define  MCOM_EMPTY_STRING   "(EMPTY)" #define  PLAYER_MCOM_PUSH_REQ   0 #define  PLAYER_MCOM_POP_REQ   1 #define  PLAYER_MCOM_READ_REQ   2 #define  PLAYER_MCOM_CLEAR_REQ   3 #define  PLAYER_MCOM_SET_CAPACITY_REQ   4 Typedefs typedef player_mcom_data  player_mcom_data_t   A piece of data. typedef player_mcom_config  player_mcom_config_t   Configuration request: Config requests sent to server. typedef player_mcom_return  player_mcom_return_t   Configuration reply from server. Define Documentation #define MCOM_DATA_LEN   128   size of the data field in messages #define MCOM_COMMAND_BUFFER_SIZE   (sizeof(player_mcom_config_t)) #define MCOM_DATA_BUFFER_SIZE   0 #define MCOM_N_BUFS   10   number of buffers to keep per channel #define MCOM_CHANNEL_LEN   8   size of channel name #define MCOM_EMPTY_STRING   "(EMPTY)"   returns this if empty #define PLAYER_MCOM_PUSH_REQ   0 #define PLAYER_MCOM_POP_REQ   1 #define PLAYER_MCOM_READ_REQ   2 #define PLAYER_MCOM_CLEAR_REQ   3 #define PLAYER_MCOM_SET_CAPACITY_REQ   4 Typedef Documentation typedef struct player_mcom_data player_mcom_data_t   A piece of data. typedef struct player_mcom_config player_mcom_config_t   Configuration request: Config requests sent to server. typedef struct player_mcom_return player_mcom_return_t   Configuration reply from server.