Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

LifoMCom Class Reference

#include <lifomcom.h>

Inherits Driver.

List of all members.

Public Member Functions

 LifoMCom (ConfigFile *cf, int section)
virtual int PutConfig (player_device_id_t id, void *client, void *src, size_t len, struct timeval *timestamp)
 Write configuration request to the request queue.

virtual int Setup ()
 Initialize the driver.

virtual int Shutdown ()
 Finalize the driver.


Constructor & Destructor Documentation

LifoMCom::LifoMCom ConfigFile cf,
int  section
 


Member Function Documentation

int LifoMCom::PutConfig player_device_id_t  id,
void *  client,
void *  src,
size_t  len,
struct timeval *  timestamp
[virtual]
 

Write configuration request to the request queue.

Unlike data and commands, requests are added to a queue. This function will usually be called by the server.

Parameters:
id Specifies the device to be written.
client A generic pointer for routing replies (advanced usage only).
src Pointer to source buffer.
len Length of the source buffer (bytes).
timestamp Command timestamp; if NULL, the current server time will be used.
Returns:
Returns 0 on success (queues may overflow, generating an error).

Reimplemented from Driver.

virtual int LifoMCom::Setup  )  [inline, virtual]
 

Initialize the driver.

This function is called with the first client subscribes; it MUST be implemented by the driver.

Returns:
Returns 0 on success.

Implements Driver.

virtual int LifoMCom::Shutdown  )  [inline, virtual]
 

Finalize the driver.

This function is called with the last client unsubscribes; it MUST be implemented by the driver.

Returns:
Returns 0 on success.

Implements Driver.


The documentation for this class was generated from the following files:
Generated on Tue May 3 14:15:51 2005 for Player by doxygen 1.3.6