Message types
Messaging basics

The Player message types. More...

#define | PLAYER_MSGTYPE_DATA 1
| A data message. More...
#define | PLAYER_MSGTYPE_CMD 2
| A command message. More...
#define | PLAYER_MSGTYPE_REQ 3
| A request message. More...
#define | PLAYER_MSGTYPE_RESP_ACK 4
| A positive response message. More...
#define | PLAYER_MSGTYPE_SYNCH 5
| A synch message. More...
#define | PLAYER_MSGTYPE_RESP_NACK 6
| A negative response message. More...

## Detailed Description

The Player message types.

## Macro Definition Documentation

#define PLAYER_MSGTYPE_CMD 2

A command message.

Such messages are asynchronously published to devices, and are usually used to change some aspect of the device's state.

Referenced by SegwayRMP400::HandlePosition2DCmd(), SegwayRMP400::HandlePosition3DCmd(), GarciaDriver::ProcessMessage(), SegwayRMP::ProcessMessage(), snd::ProcessMessage(), SphereDriver::ProcessMessage(), Alsa::ProcessMessage(), SegwayRMP400::ProcessMessage(), ER::ProcessMessage(), Khepera::ProcessMessage(), RFLEX::ProcessMessage(), wbr914::ProcessMessage(), ClodBuster::ProcessMessage(), Erratic::ProcessMessage(), and P2OS::ProcessMessage().

#define PLAYER_MSGTYPE_DATA 1

A data message.

Such messages are asynchronously published from devices, and are usually used to reflect some part of the device's state.

Referenced by CameraUvc::Main(), ER::Main(), REB::Main(), SegwayRMP::Main(), RFLEX::Main(), ClodBuster::Main(), SegwayRMP400::ProcessData(), GarciaDriver::ProcessMessage(), snd::ProcessMessage(), LaserTransform::ProcessMessage(), ImageBase::ProcessMessage(), and SegwayRMP400::ProcessMessage().

#define PLAYER_MSGTYPE_REQ 3

A request message.

Such messages are published synchronously to devices, usually to get or set some aspect of the device's state that is not available in data or command messages. Every request message gets a response message (either PLAYER_MSGTYPE_RESP_ACK or PLAYER_MSGTYPE_RESP_NACK).

Referenced by FromRanger::ProcessMessage(), ToRanger::ProcessMessage(), GarciaDriver::ProcessMessage(), SphereDriver::ProcessMessage(), SegwayRMP::ProcessMessage(), snd::ProcessMessage(), LaserTransform::ProcessMessage(), MapTransform::ProcessMessage(), Alsa::ProcessMessage(), SegwayRMP400::ProcessMessage(), AdaptiveMCL::ProcessMessage(), ER::ProcessMessage(), Khepera::ProcessMessage(), RFLEX::ProcessMessage(), wbr914::ProcessMessage(), ClodBuster::ProcessMessage(), Erratic::ProcessMessage(), and P2OS::ProcessMessage().

#define PLAYER_MSGTYPE_RESP_ACK 4

A positive response message.

Such messages are published in response to a PLAYER_MSGTYPE_REQ. This message indicates that the underlying driver received, interpreted, and processed the request. Any requested data is in the body of this response message.

Referenced by FromRanger::ProcessMessage(), ToRanger::ProcessMessage(), SphereDriver::ProcessMessage(), LaserTransform::ProcessMessage(), MapTransform::ProcessMessage(), SegwayRMP400::ProcessMessage(), AdaptiveMCL::ProcessMessage(), ER::ProcessMessage(), Khepera::ProcessMessage(), RFLEX::ProcessMessage(), and ClodBuster::ProcessMessage().

#define PLAYER_MSGTYPE_RESP_NACK 6

A negative response message.

Such messages are published in response to a PLAYER_MSGTYPE_REQ. This messages indicates that the underlying driver did not process the message. Possible causes include: the driver's message queue was full, the driver failed to interpret the request, or the the driver does not support the request. This message will have no data in the body.

Referenced by FromRanger::ProcessMessage(), ToRanger::ProcessMessage(), LaserTransform::ProcessMessage(), ER::ProcessMessage(), and Khepera::ProcessMessage().

#define PLAYER_MSGTYPE_SYNCH 5

A synch message.

Only used in PLAYER_DATAMODE_PULL mode. Sent at the end of the set of messages that are sent in response to a PLAYER_PLAYER_REQ_DATA request.

Last updated 12 September 2005 21:38:45