mcom
[Interface specifications]
Detailed Description
Client - client communication.
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 (deprecated) driver enforces a last-in-first-out stack.
- Todo:
- Is this interface used and/or needed any more?
| #define | MCOM_DATA_LEN 128 |
| size of the data field in messages | |
| #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 0 |
| request ids | |
| #define | PLAYER_MCOM_POP 1 |
| request ids | |
| #define | PLAYER_MCOM_READ 2 |
| request ids | |
| #define | PLAYER_MCOM_CLEAR 3 |
| request ids | |
| #define | PLAYER_MCOM_SET_CAPACITY 4 |
| request ids | |
| #define | MCOM_COMMAND_BUFFER_SIZE (sizeof(player_mcom_config_t)) |
| ?? | |
| typedef player_mcom_data | player_mcom_data_t |
| A piece of data. | |
| typedef player_mcom_config | player_mcom_config_t |
| Configuration request to the device. | |
| typedef player_mcom_return | player_mcom_return_t |
| Configuration reply from the device. |