Urbi SDK Remote for C++  2.7.5
Public Member Functions | Public Attributes | Private Member Functions
urbi::UMessage Class Reference

Class containing all informations related to an URBI message. More...

#include <umessage.hh>

Collaboration diagram for urbi::UMessage:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 UMessage (UAbstractClient &client)
 UMessage (UAbstractClient &client, int timestamp, const char *tag, const char *message, const binaries_type &bins=binaries_type())
 Parser constructor.
 UMessage (UAbstractClient &client, int timestamp, const std::string &tag, const std::string &message, const binaries_type &bins=binaries_type())
 Likewise.
 UMessage (const UMessage &source)
 ~UMessage ()
 Free everything if data was copied, doesn't free anything otherwise.
 operator urbi::UValue & ()
 Return the message.
std::ostream & print (std::ostream &o) const
 Format as "[TIMESTAMP:TAG] (!!!|***)? CONTENTS".

Public Attributes

UAbstractClient & client
 Connection from which originated the message.
int timestamp
 Server-side timestamp.
std::string tag
 Associated tag.
UMessageType type
 The type of this message.
urbi::UValue * value
 Set only if the message type is MESSAGE_DATA.
std::string message
 Set only if the message type is MESSAGE_SYSTEM or MESSAGE_ERROR.
std::string rawMessage
 Raw message without the binary data.

Private Member Functions

void init_ (const binaries_type &bins)
 Factor common code between ctors.

Detailed Description

Class containing all informations related to an URBI message.

Definition at line 35 of file umessage.hh.

Constructor & Destructor Documentation

urbi::UMessage::UMessage ( UAbstractClient &  client)

Definition at line 28 of file umessage.cc.

urbi::UMessage::UMessage ( UAbstractClient &  client,
int  timestamp,
const char *  tag,
const char *  message,
const binaries_type &  bins = binaries_type() 
)

Parser constructor.

Keeps a copy of tag and message.

Definition at line 66 of file umessage.cc.

References init_().

urbi::UMessage::UMessage ( UAbstractClient &  client,
int  timestamp,
const std::string &  tag,
const std::string &  message,
const binaries_type &  bins = binaries_type() 
)

Likewise.

Definition at line 78 of file umessage.cc.

References init_().

urbi::UMessage::UMessage ( const UMessage &  source)

Definition at line 90 of file umessage.cc.

References message, urbi::MESSAGE_ERROR, urbi::MESSAGE_SYSTEM, type, and value.

urbi::UMessage::~UMessage ( )

Free everything if data was copied, doesn't free anything otherwise.

Definition at line 111 of file umessage.cc.

References urbi::MESSAGE_ERROR, urbi::MESSAGE_SYSTEM, type, and value.

Member Function Documentation

void urbi::UMessage::init_ ( const binaries_type &  bins) [private]

Factor common code between ctors.

Works on rawMessage.

Definition at line 35 of file umessage.cc.

References client, message, urbi::MESSAGE_DATA, urbi::MESSAGE_ERROR, urbi::MESSAGE_SYSTEM, urbi::UValue::parse(), rawMessage, type, and value.

Referenced by UMessage().

urbi::UMessage::operator urbi::UValue & ( ) [inline]

Return the message.

Definition at line 55 of file umessage.hxx.

std::ostream & urbi::UMessage::print ( std::ostream &  o) const

Format as "[TIMESTAMP:TAG] (!!!|***)? CONTENTS".

Definition at line 118 of file umessage.cc.

References message, urbi::MESSAGE_DATA, urbi::MESSAGE_ERROR, urbi::MESSAGE_SYSTEM, tag, timestamp, type, and value.

Referenced by urbi::operator<<().

Member Data Documentation

UAbstractClient& urbi::UMessage::client

Connection from which originated the message.

Definition at line 62 of file umessage.hh.

Referenced by init_().

std::string urbi::UMessage::message

Set only if the message type is MESSAGE_SYSTEM or MESSAGE_ERROR.

Definition at line 74 of file umessage.hh.

Referenced by urbi::UAbstractClient::clientError(), init_(), onError(), print(), and UMessage().

std::string urbi::UMessage::rawMessage

Raw message without the binary data.

Definition at line 76 of file umessage.hh.

Referenced by urbi::UAbstractClient::clientError(), and init_().

std::string urbi::UMessage::tag

Associated tag.

Definition at line 66 of file umessage.hh.

Referenced by urbi::UAbstractClient::clientError(), urbi::matching_tag(), urbi::USyncClient::notifyCallbacks(), urbi::UAbstractClient::notifyCallbacks(), urbi::impl::RemoteUContextImpl::onRTPListenMessage(), urbi::impl::RemoteUObjectImpl::onUpdate(), print(), urbi::sendSound_(), and transmitRemoteWrite().

int urbi::UMessage::timestamp

Server-side timestamp.

Definition at line 64 of file umessage.hh.

Referenced by urbi::UAbstractClient::clientError(), and print().

UMessageType urbi::UMessage::type

The type of this message.

Definition at line 69 of file umessage.hh.

Referenced by urbi::UAbstractClient::clientError(), urbi::impl::RemoteUContextImpl::dispatcher(), urbi::getValue(), init_(), urbi::matching_tag(), urbi::impl::RemoteUContextImpl::onRTPListenMessage(), urbi::impl::RemoteUObjectImpl::onUpdate(), print(), urbi::UAbstractClient::setConnectionID(), urbi::UAbstractClient::setVersion(), urbi::impl::RemoteUVarImpl::sync(), urbi::USyncClient::syncGetImage(), urbi::USyncClient::syncGetSound(), transmitRemoteWrite(), UMessage(), urbi::USyncClient::waitForTag(), and ~UMessage().

urbi::UValue* urbi::UMessage::value

Set only if the message type is MESSAGE_DATA.

Definition at line 72 of file umessage.hh.

Referenced by urbi::impl::RemoteUContextImpl::dispatcher(), urbi::impl::RemoteUVarImpl::getProp(), urbi::getValue(), init_(), urbi::impl::RemoteUContextImpl::onRTPListenMessage(), urbi::impl::RemoteUObjectImpl::onUpdate(), print(), urbi::impl::RemoteUContextImpl::RemoteUContextImpl(), urbi::UAbstractClient::setConnectionID(), urbi::UAbstractClient::setVersion(), urbi::impl::RemoteUVarImpl::sync(), urbi::USyncClient::syncGetImage(), urbi::USyncClient::syncGetSound(), transmitRemoteWrite(), UMessage(), and ~UMessage().

The documentation for this class was generated from the following files: