iso::com::Receiver Class Reference

#include <iso_com_receiver.h>

Collaboration diagram for iso::com::Receiver:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Receiver (const base::String &pName)
 constructor
 Receiver (const base::String &pName, MessageParser *pMessageParser, NetworkReceiverProtocol *pNetworkProtocol)
 constructor
 ~Receiver ()
 destructor
const MessageParserparser () const
 return message parser
const NetworkReceiverProtocolprotocol () const
 return network protocol
const base::String & name () const
 return receiver name
bool messagesAvailable () const
 check if messages are available
void removeAvailableMessages ()
 remove available messages
const QVector< Message * > & messages () const
 retrieve available messages
bool messageAvailable () const
 check if message is available
void removeAvailableMessage ()
 remove available message
const Messagemessage () const throw (ComException)
 retrieve available message
void setMessage (const Message &pMessage)
 directly set message
void receive ()
void run ()
 thread run
void abort ()
 stop receiving current message

Protected Member Functions

 Receiver ()
 default constructor

Protected Attributes

base::String mName
MessageParsermMessageParser
 name
NetworkReceiverProtocolmNetworkProtocol
 message parser
bool mAbort
 network message protocol
QMutex mLock
QVector< Message * > mMessages
 receiver blocked

Constructor & Destructor Documentation

Receiver::Receiver ( const base::String &  pName  ) 

constructor

Parameters:
pName receiver name

Receiver::Receiver ( const base::String &  pName,
MessageParser pMessageParser,
NetworkReceiverProtocol pNetworkProtocol 
)

constructor

Parameters:
pName receiver name
pMessageParser message parser
pNetworkProtocol 

Receiver::~Receiver (  ) 

destructor

Receiver::Receiver (  )  [protected]

default constructor


Member Function Documentation

const MessageParser * Receiver::parser (  )  const

return message parser

Returns:
message parser

const NetworkReceiverProtocol * Receiver::protocol (  )  const

return network protocol

Returns:
network protocol

const base::String & Receiver::name (  )  const

return receiver name

Returns:
receiver name

bool Receiver::messagesAvailable (  )  const

check if messages are available

Returns:
true if messages are available, false otherwise

void Receiver::removeAvailableMessages (  ) 

remove available messages

const QVector< Message * > & Receiver::messages (  )  const

retrieve available messages

Returns:
messages

bool Receiver::messageAvailable (  )  const

check if message is available

Returns:
true if message is available, false otherwise

void Receiver::removeAvailableMessage (  ) 

remove available message

const Message & Receiver::message (  )  const throw (ComException)

retrieve available message

Returns:
message
Exceptions:
ComException no message available

void Receiver::setMessage ( const Message pMessage  ) 

directly set message

Parameters:
pMessage message

void Receiver::receive (  ) 

void update receiver

void Receiver::run (  ) 

thread run

void Receiver::abort (  ) 

stop receiving current message


Member Data Documentation

base::String iso::com::Receiver::mName [protected]

MessageParser* iso::com::Receiver::mMessageParser [protected]

name

NetworkReceiverProtocol* iso::com::Receiver::mNetworkProtocol [protected]

message parser

bool iso::com::Receiver::mAbort [protected]

network message protocol

QMutex iso::com::Receiver::mLock [protected]

QVector< Message* > iso::com::Receiver::mMessages [protected]

receiver blocked


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 13:53:12 2011 for iso_com by  doxygen 1.5.1