FromRanger Class Reference
Inheritance diagram for FromRanger:
Public Member Functions | |
FromRanger (ConfigFile *cf, int section) | |
virtual int | ProcessMessage (QueuePointer &resp_queue, player_msghdr *hdr, void *data) |
Message handler. | |
virtual int | Setup (void) |
Initialize the driver. | |
virtual int | Shutdown (void) |
Finalize the driver. | |
Protected Attributes | |
Device * | inputDevice |
player_devaddr_t | inputDeviceAddr |
Member Function Documentation
int FromRanger::ProcessMessage | ( | QueuePointer & | resp_queue, |
player_msghdr * | hdr, | ||
void * | data | ||
) | [virtual] |
Message handler.
This function is called once for each message in the incoming queue. Reimplement it to provide message handling. Return 0 if you handled the message and -1 otherwise
- Parameters:
-
resp_queue The queue to which any response should go. hdr The message header data The message body
Reimplemented from Driver.
References player_msghdr::addr, Driver::device_addr, Driver::InQueue, Message::MatchMessage(), PLAYER_MSGTYPE_REQ, PLAYER_MSGTYPE_RESP_ACK, PLAYER_MSGTYPE_RESP_NACK, Driver::Publish(), Device::PutMsg(), and Driver::ret_queue.
int FromRanger::Setup | ( | void | ) | [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.
Reimplemented from Driver.
int FromRanger::Shutdown | ( | void | ) | [virtual] |
Finalize the driver.
This function is called with the last client unsubscribes.
- Returns:
- Returns 0 on success.
Reimplemented from Driver.
The documentation for this class was generated from the following files:
- fromranger.h
- fromranger.cc