_playerc_client_t Struct Reference
[Client API]
#include <playerc.h>
Detailed Description
Client object data.
Public Attributes | |
| void * | id |
| A useful ID for identifying devices; mostly used by other language bindings. | |
| char * | host |
| Server address. | |
| int | port |
| int | transport |
| struct sockaddr_in | server |
| int | retry_limit |
| How many times we'll try to reconnect after a socket error. | |
| double | retry_time |
| How long to sleep, in seconds, to sleep between reconnect attempts. | |
| uint32_t | overflow_count |
| How many messages were lost on the server due to overflows, incremented by player, cleared by user. | |
| int | sock |
| uint8_t | mode |
| int | data_requested |
| int | data_received |
| playerc_device_info_t | devinfos [PLAYER_MAX_DEVICES] |
| List of available (but not necessarily subscribed) devices. | |
| int | devinfo_count |
| struct _playerc_device_t * | device [PLAYER_MAX_DEVICES] |
| List of subscribed devices. | |
| int | device_count |
| playerc_client_item_t | qitems [PLAYERC_QUEUE_RING_SIZE] |
| int | qfirst |
| int | qlen |
| int | qsize |
| char * | data |
| char * | write_xdrdata |
| char * | read_xdrdata |
| size_t | read_xdrdata_len |
| double | datatime |
| Server time stamp on the last packet. | |
| double | lasttime |
| Server time stamp on the previous packet. | |
| double | request_timeout |
Member Data Documentation
| void* _playerc_client_t::id |
A useful ID for identifying devices; mostly used by other language bindings.
| char* _playerc_client_t::host |
Server address.
How many times we'll try to reconnect after a socket error.
Use playerc_client_set_retry_limit() to set this value. Set to -1 for infinite retry.
Referenced by PlayerCc::PlayerClient::GetRetryLimit().
How long to sleep, in seconds, to sleep between reconnect attempts.
Use playerc_client_set_retry_time() to set this value.
Referenced by PlayerCc::PlayerClient::GetRetryTime().
| uint32_t _playerc_client_t::overflow_count |
How many messages were lost on the server due to overflows, incremented by player, cleared by user.
For internal use only.
Socket descriptor
| uint8_t _playerc_client_t::mode |
For internal use only.
Data delivery mode
For internal use only.
Data request flag; if mode == PLAYER_DATAMODE_PULL, have we requested and not yet received a round of data?
For internal use only.
Data request flag; if mode == PLAYER_DATAMODE_PULL, have we received any data in this round?
| playerc_device_info_t _playerc_client_t::devinfos[PLAYER_MAX_DEVICES] |
List of available (but not necessarily subscribed) devices.
This list is filled in by playerc_client_get_devlist().
| playerc_client_item_t _playerc_client_t::qitems[PLAYERC_QUEUE_RING_SIZE] |
For internal use only.
A circular queue used to buffer incoming data packets.
| char* _playerc_client_t::data |
For internal use only.
Temp buffers for incoming / outgoing packets.
| double _playerc_client_t::datatime |
Server time stamp on the last packet.
| double _playerc_client_t::lasttime |
Server time stamp on the previous packet.
The documentation for this struct was generated from the following file: