_playerc_client_t Struct Reference
[Client API]

#include <playerc.h>

Collaboration diagram for _playerc_client_t:

Collaboration graph
[legend]
List of all members.

Detailed Description

Client object data.

Definition at line 447 of file playerc.h.


Public Attributes

void * id
 A useful ID for identifying devices; mostly used by other language bindings.
char * host
 Server address.
int port
int transport
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
 

For internal use only.

Socket descriptor


uint8_t mode
 

For internal use only.

Data delivery mode


int data_requested
 

For internal use only.

Data request flag; if mode == PLAYER_DATAMODE_PULL, have we requested and not yet received a round of data?


int data_received
 

For internal use only.

Data request flag; if mode == PLAYER_DATAMODE_PULL, have we received any data in this round?


playerc_device_info_t devinfos [PLAYER_MAX_DEVICES]
 List of available (but not necessarily subscribed) devices.
int devinfo_count
_playerc_device_tdevice [PLAYER_MAX_DEVICES]
 List of subscribed devices.
int device_count
playerc_client_item_t qitems [PLAYERC_QUEUE_RING_SIZE]
 

For internal use only.

A circular queue used to buffer incoming data packets.


int qfirst
int qlen
int qsize
char * data
 

For internal use only.

Temp buffers for incoming / outgoing packets.


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

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.

Definition at line 462 of file playerc.h.

How long to sleep, in seconds, to sleep between reconnect attempts.

Use playerc_client_set_retry_time() to set this value.

Definition at line 466 of file playerc.h.

List of available (but not necessarily subscribed) devices.

This list is filled in by playerc_client_get_devlist().

Definition at line 489 of file playerc.h.


The documentation for this struct was generated from the following file:

Last updated 12 September 2005 21:38:45