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

Client object [libgazebo] Classes struct   gz_client   Client data. More... Defines #define  GZ_SEM_KEY   0x135135FA   Semaphore key used by Gazebo. #define  GZ_CLIENT_ID_USER_FIRST   0x00   Reserved client IDs. #define  GZ_CLIENT_ID_USER_LAST   0x07 #define  GZ_CLIENT_ID_WXGAZEBO   0x08 #define  GZ_CLIENT_ID_PLAYER   0x09 Typedefs typedef gz_client  gz_client_t   Client data. Functions gz_client_t *  gz_client_alloc ()   Create a new client. void  gz_client_free (gz_client_t *self)   Destroy a client. int  gz_client_query (gz_client_t *self, int server_id) int  gz_client_connect (gz_client_t *self, int server_id)   Connect to the server (non-blocking mode). int  gz_client_connect_wait (gz_client_t *self, int server_id, int client_id)   Connect to the server (blocking mode). int  gz_client_disconnect (gz_client_t *self)   Disconnect from the server. int  gz_client_wait (gz_client_t *self)   Wait for new data to be posted (blocking mode). Detailed Description The client object is used by Gazebo clients to establish a connection with a running server. See the Using libgazebo for an overview. Define Documentation #define GZ_SEM_KEY   0x135135FA   Semaphore key used by Gazebo. #define GZ_CLIENT_ID_USER_FIRST   0x00   Reserved client IDs. User programs may use numbers in the range GZ_SEM_NUM_USER to GZ_SEM_NUM_USER_LAST, inclusive. All other semaphore numbers are reserved. #define GZ_CLIENT_ID_USER_LAST   0x07 #define GZ_CLIENT_ID_WXGAZEBO   0x08 #define GZ_CLIENT_ID_PLAYER   0x09 Typedef Documentation typedef struct gz_client gz_client_t   Client data. Function Documentation gz_client_t* gz_client_alloc (   )    Create a new client. void gz_client_free (  gz_client_t *  self  )    Destroy a client. int gz_client_query (  gz_client_t *  self, int  server_id )    Test for the presence of the server. Returns: The return value is 0 if the server is present; +1 if the server is not present; -1 if there is an error. int gz_client_connect (  gz_client_t *  self, int  server_id )    Connect to the server (non-blocking mode). int gz_client_connect_wait (  gz_client_t *  self, int  server_id, int  client_id )    Connect to the server (blocking mode). Parameters: self  Pointer to Itself. server_id  Server ID; each server must have a unique id. client_id  Client ID; in blocking mode, each client must have a unique id. int gz_client_disconnect (  gz_client_t *  self  )    Disconnect from the server. int gz_client_wait (  gz_client_t *  self  )    Wait for new data to be posted (blocking mode). Returns: Returns 0 on success, -1 on error.

---

Last updated $Date: 2004/12/21 01:49:15 $

---