player
[Interface specifications]
Detailed Description
Player: the meta-device.
The player device represents the server itself, and is used in configuring the behavior of the server. There is only one such device (with index 0) and it is always open.
- Todo:
- Determine what, if any, data delivery modes and requests are needed.
| #define | PLAYER_OPEN_MODE 1 |
| Device access mode: open. | |
| #define | PLAYER_CLOSE_MODE 2 |
| Device access mode: close. | |
| #define | PLAYER_ERROR_MODE 3 |
| Device access mode: error. | |
| #define | PLAYER_DATAMODE_PUSH 1 |
| Data delivery mode: Send data from all subscribed devices all the time (i.e. | |
| #define | PLAYER_DATAMODE_PULL 2 |
| Data delivery mode: Only on request, send data from all subscribed devices. | |
| #define | PLAYER_PLAYER_REQ_DEVLIST 1 |
| Request/reply subtype: get device list. | |
| #define | PLAYER_PLAYER_REQ_DRIVERINFO 2 |
| Request/reply subtype: get driver info. | |
| #define | PLAYER_PLAYER_REQ_DEV 3 |
| Request/reply subtype: (un)subscribe to device. | |
| #define | PLAYER_PLAYER_REQ_DATA 4 |
| Device access mode: open. | |
| #define | PLAYER_PLAYER_REQ_DATAMODE 5 |
| Device access mode: open. | |
| #define | PLAYER_PLAYER_REQ_AUTH 7 |
| Device access mode: open. | |
| #define | PLAYER_PLAYER_REQ_NAMESERVICE 8 |
| Device access mode: open. | |
| #define | PLAYER_PLAYER_REQ_IDENT 9 |
| Device access mode: open. | |
| #define | PLAYER_PLAYER_REQ_ADD_REPLACE_RULE 10 |
| Device access mode: open. | |
|
typedef struct player_device_devlist | player_device_devlist_t |
| Device access mode: open. | |
|
typedef struct player_device_driverinfo | player_device_driverinfo_t |
| Device access mode: open. | |
| typedef struct player_device_req | player_device_req_t |
| Device access mode: open. | |
|
typedef struct player_device_data_req | player_device_data_req_t |
| Device access mode: open. | |
|
typedef struct player_device_datamode_req | player_device_datamode_req_t |
| Device access mode: open. | |
|
typedef struct player_device_auth_req | player_device_auth_req_t |
| Device access mode: open. | |
|
typedef struct player_device_nameservice_req | player_device_nameservice_req_t |
| Device access mode: open. | |
|
typedef struct player_add_replace_rule_req | player_add_replace_rule_req_t |
| Device access mode: open. |
Define Documentation
| #define PLAYER_DATAMODE_PULL 2 |
Data delivery mode: Only on request, send data from all subscribed devices.
A PLAYER_MSGTYPE_SYNCH packet follows each set of data. Request should be made automatically by client libraries when they begin reading.
| #define PLAYER_DATAMODE_PUSH 1 |
Data delivery mode: Send data from all subscribed devices all the time (i.e.
when it's ready on the server).