Message types
[Messaging basics]
Collaboration diagram for Message types:
|
Detailed Description
The Player message types.
| #define | PLAYER_MSGTYPE_DATA 1 |
| A data message. | |
| #define | PLAYER_MSGTYPE_CMD 2 |
| A command message. | |
| #define | PLAYER_MSGTYPE_REQ 3 |
| A request message. | |
| #define | PLAYER_MSGTYPE_RESP_ACK 4 |
| A positive response message. | |
| #define | PLAYER_MSGTYPE_SYNCH 5 |
| A synch message. | |
| #define | PLAYER_MSGTYPE_RESP_NACK 6 |
| A negative response message. |
Define 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.
Definition at line 95 of file player.h.
Referenced by P2OS::HandleActArrayCommand(), P2OS::HandleArmGripperCommand(), wbr914::HandleCommand(), P2OS::HandleCommand(), Erratic::HandleCommand(), P2OS::HandleGripperCommand(), P2OS::HandleLiftCommand(), P2OS::HandleLimbCommand(), P2OS::P2OS(), wbr914::ProcessMessage(), SphereDriver::ProcessMessage(), SegwayRMP::ProcessMessage(), RFLEX::ProcessMessage(), REB::ProcessMessage(), P2OS::ProcessMessage(), Khepera::ProcessMessage(), GarciaDriver::ProcessMessage(), Erratic::ProcessMessage(), ER::ProcessMessage(), ClodBuster::ProcessMessage(), Alsa::ProcessMessage(), and Nav200::WriteCommand().
| #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.
Definition at line 91 of file player.h.
Referenced by P2OS::ActarrayPutData(), P2OS::BlobfinderPutData(), P2OS::GyroPutData(), SegwayRMP::Main(), RFLEX::Main(), REB::Main(), ER::Main(), ClodBuster::Main(), CameraUvc::Main(), LaserTransform::ProcessMessage(), ImageBase::ProcessMessage(), GarciaDriver::ProcessMessage(), AMCLOdom::ProcessMessage(), AMCLLaser::ProcessMessage(), Erratic::PublishAIn(), wbr914::PublishData(), Erratic::PublishIR(), Alsa::PublishMixerData(), Erratic::PublishPosition2D(), Erratic::PublishPower(), Alsa::PublishRecordedData(), Erratic::PublishSonar(), AdaptiveMCL::PutDataLocalize(), AdaptiveMCL::PutDataPosition(), Nav200::ReadFromNav200(), StatGrabDriver::RefreshData(), SphereDriver::RefreshData(), GarciaDriver::RefreshData(), Khepera::ResetOdometry(), Alsa::SendStateMessage(), REB::SetOdometry(), P2OS::StandardSIPPutData(), REB::UpdateData(), Khepera::UpdateData(), and Nav200::WriteCommand().
| #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).
Definition at line 102 of file player.h.
Referenced by MapTransform::GetMap(), wbr914::HandleConfig(), P2OS::HandleConfig(), Erratic::HandleConfig(), wbr914::ProcessMessage(), ToRanger::ProcessMessage(), SphereDriver::ProcessMessage(), SegwayRMP::ProcessMessage(), RFLEX::ProcessMessage(), REB::ProcessMessage(), P2OS::ProcessMessage(), MapTransform::ProcessMessage(), LifoMCom::ProcessMessage(), LaserTransform::ProcessMessage(), Khepera::ProcessMessage(), GarciaDriver::ProcessMessage(), Erratic::ProcessMessage(), ER::ProcessMessage(), ClodBuster::ProcessMessage(), AdaptiveMCL::ProcessMessage(), Alsa::ProcessMessage(), AMCLLaser::Setup(), and AMCLLaser::SetupMap().
| #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.
Definition at line 108 of file player.h.
Referenced by wbr914::HandleConfig(), P2OS::HandleConfig(), Erratic::HandleConfig(), Alsa::HandleMixerChannelLevelReq(), Alsa::HandleMixerChannelListReq(), SegwayRMP::HandlePosition3DConfig(), SegwayRMP::HandlePositionConfig(), Alsa::HandleSampleLoadReq(), Alsa::HandleSampleRecordReq(), Alsa::HandleSampleRetrieveReq(), AdaptiveMCL::ProcessGeom(), GarciaDriver::ProcessIrPoseReq(), ToRanger::ProcessMessage(), SphereDriver::ProcessMessage(), RFLEX::ProcessMessage(), REB::ProcessMessage(), MapTransform::ProcessMessage(), LifoMCom::ProcessMessage(), LaserTransform::ProcessMessage(), Khepera::ProcessMessage(), ER::ProcessMessage(), ClodBuster::ProcessMessage(), AdaptiveMCL::ProcessMessage(), and GarciaDriver::ProcessPos2dGeomReq().
| #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.
Definition at line 121 of file player.h.
Referenced by SegwayRMP::HandlePositionConfig(), ToRanger::ProcessMessage(), LifoMCom::ProcessMessage(), LaserTransform::ProcessMessage(), Khepera::ProcessMessage(), and ER::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.