#include <iso_com_messenger.h>
Public Member Functions | |
Messenger () | |
create messenger | |
virtual | ~Messenger () |
destructor | |
QList< base::String > | senderNames () const |
return sender names | |
bool | checkSender (const base::String &pSenderName) const |
check sender | |
Sender * | sender (const base::String &pSenderName) throw (ComException) |
retrieve sender | |
Format | senderFormat (Sender *pSender) |
return sender format | |
Format | senderFormat (const base::String &pSenderName) const throw (ComException) |
return sender format | |
Protocol | senderProtocol (const base::String &pSenderName) const throw (ComException) |
return sender protocol | |
base::String | senderIP (const base::String &pSenderName) const throw (ComException) |
return sender ip | |
unsigned int | senderPort (const base::String &pSenderName) const throw (ComException) |
return sender ip | |
void | addSender (Sender *pSender) throw (ComException) |
add sender | |
void | createSender (const base::String &pSenderName, const base::String &pReceiverName) throw (ComException) |
create direct sender | |
void | createSender (const base::String &pSenderName, const base::String &pReceiverIP, unsigned int pReceiverPort, Protocol pComProt, Format pComForm) throw (ComException) |
create network sender | |
virtual void | removeSender (const base::String &pSenderName) throw (ComException) |
remove sender | |
virtual void | removeSenders () |
remove all senders | |
QList< base::String > | receiverNames () const |
return receiver names | |
bool | checkReceiver (const base::String &pReceiverName) const |
check receiver | |
Receiver * | receiver (const base::String &pReceiverName) throw (ComException) |
retrieve receiver | |
Format | receiverFormat (const base::String &pReceiverName) const throw (ComException) |
return receiver format | |
Protocol | receiverProtocol (const base::String &pReceiverName) const throw (ComException) |
return receiver protocol | |
unsigned int | receiverPort (const base::String &pReceiverName) const throw (ComException) |
return receiver port | |
void | addReceiver (Receiver *pReceiver) throw (ComException) |
add receiver | |
void | createReceiver (const base::String &pReceiverName) throw (ComException) |
create direct receiver | |
void | createReceiver (const base::String &pReceiverName, unsigned int pListeningPort, Protocol pComProt, Format pComForm) throw (ComException) |
create network receiver | |
virtual void | removeReceiver (const base::String &pReceiverName) throw (ComException) |
remove receiver | |
virtual void | removeReceivers () |
remove all receivers | |
void | registerMessageListener (const base::String &pReceiverName, MessageListener &pMessageListener) throw (ComException) |
register message listener | |
void | send (const Message &pMessage) |
send message | |
void | send (const base::String &pSenderName, const Message &pMessage) throw (ComException) |
send message | |
void | receive () |
calls receive on all receivers | |
bool | messageAvailable (const base::String &pReceiverName) const throw (ComException) |
check if receiver has available message | |
Message | message (const base::String &pReceiverName, int pTimeOut) throw (ComException) |
retrieve message from receiver | |
void | clearMessage (const base::String &pReceiverName) const throw (ComException) |
remove available message | |
virtual void | update () |
update messenger | |
Protected Member Functions | |
void | updateMessageListeners () |
message listeners | |
Protected Attributes | |
QHash< base::String, Sender * > | mSenders |
QHash< base::String, Receiver * > | mReceivers |
message sender repository | |
QMultiHash< Receiver *, MessageListener * > | mMessageListeners |
message receiver repository |
Messenger::Messenger | ( | ) |
create messenger
Messenger::~Messenger | ( | ) | [virtual] |
destructor
QList< base::String > Messenger::senderNames | ( | ) | const |
return sender names
bool Messenger::checkSender | ( | const base::String & | pSenderName | ) | const |
check sender
pSenderName | name of sender |
Sender * Messenger::sender | ( | const base::String & | pSenderName | ) | throw (ComException) |
retrieve sender
pSenderName | name of sender |
ComException | sender not found |
return sender format
pSender | sender |
Format Messenger::senderFormat | ( | const base::String & | pSenderName | ) | const throw (ComException) |
return sender format
pSenderName | name of sender |
ComException | sender not found |
Protocol Messenger::senderProtocol | ( | const base::String & | pSenderName | ) | const throw (ComException) |
return sender protocol
pSenderName | name of sender |
ComException | sender not found |
base::String Messenger::senderIP | ( | const base::String & | pSenderName | ) | const throw (ComException) |
return sender ip
pSenderName | name of sender |
ComException | sender not found |
unsigned int Messenger::senderPort | ( | const base::String & | pSenderName | ) | const throw (ComException) |
return sender ip
pSenderName | name of sender |
ComException | sender not found |
void Messenger::addSender | ( | Sender * | pSender | ) | throw (ComException) |
add sender
pSender | sender |
ComException | Exception sender with identical name already registered |
void Messenger::createSender | ( | const base::String & | pSenderName, | |
const base::String & | pReceiverName | |||
) | throw (ComException) |
create direct sender
pSenderName | name of direct sender | |
pReceiverName | name of direct receiver |
ComException | failed to create direct sender |
void Messenger::createSender | ( | const base::String & | pSenderName, | |
const base::String & | pReceiverIP, | |||
unsigned int | pReceiverPort, | |||
Protocol | pComProt, | |||
Format | pComForm | |||
) | throw (ComException) |
create network sender
pSenderName | name of network sender | |
pReceiverIP | IP address of receiver | |
pReceiverPort | port of receiver | |
pComProt | communication protocol (UDP / TCP) | |
pComForm | communication format (Default / OSC) |
ComException | failed to create network sender |
void Messenger::removeSender | ( | const base::String & | pSenderName | ) | throw (ComException) [virtual] |
remove sender
pSenderName | name of sender |
failed | to remove sender |
void Messenger::removeSenders | ( | ) | [virtual] |
remove all senders
QList< base::String > Messenger::receiverNames | ( | ) | const |
return receiver names
bool Messenger::checkReceiver | ( | const base::String & | pReceiverName | ) | const |
check receiver
pReceiverName | name of receiver |
Receiver * Messenger::receiver | ( | const base::String & | pReceiverName | ) | throw (ComException) |
retrieve receiver
pReceiverName | name of receiver |
ComException | receiver not found |
Format Messenger::receiverFormat | ( | const base::String & | pReceiverName | ) | const throw (ComException) |
return receiver format
pSenderName | name of receiver |
ComException | receiver not found |
Protocol Messenger::receiverProtocol | ( | const base::String & | pReceiverName | ) | const throw (ComException) |
return receiver protocol
pSenderName | name of receiver |
ComException | receiver not found |
unsigned int Messenger::receiverPort | ( | const base::String & | pReceiverName | ) | const throw (ComException) |
return receiver port
pReceiverName | name of receiver |
ComException | receiver not found |
void Messenger::addReceiver | ( | Receiver * | pReceiver | ) | throw (ComException) |
add receiver
pReceiver | receiver |
ComException | Exception receiver with identical name already registered |
void Messenger::createReceiver | ( | const base::String & | pReceiverName | ) | throw (ComException) |
create direct receiver
pReceiverName | name of direct receiver |
ComException | failed to create direct receiver |
void Messenger::createReceiver | ( | const base::String & | pReceiverName, | |
unsigned int | pListeningPort, | |||
Protocol | pComProt, | |||
Format | pComForm | |||
) | throw (ComException) |
create network receiver
pReceiverName | name of network receiver | |
pListeningPort | receiver listening port | |
pComProt | communication protocol (UDP / TCP) | |
pComForm | communication format (Default / OSC) |
ComException | failed to create network receiver |
void Messenger::removeReceiver | ( | const base::String & | pReceiverName | ) | throw (ComException) [virtual] |
remove receiver
pReceiverName | name of receiver |
failed | to remove receiver |
void Messenger::removeReceivers | ( | ) | [virtual] |
remove all receivers
void Messenger::registerMessageListener | ( | const base::String & | pReceiverName, | |
MessageListener & | pMessageListener | |||
) | throw (ComException) |
register message listener
pReceiverName | name of receiver | |
pMessageListener | message listener |
ComException | receiver not found |
void Messenger::send | ( | const Message & | pMessage | ) |
send message
pMessage | message |
failure in sending produces an error message in the programs verbose output
void Messenger::send | ( | const base::String & | pSenderName, | |
const Message & | pMessage | |||
) | throw (ComException) |
send message
pSenderName | name of sender | |
pMessage | message |
ComException | sender not found |
failure in sending produces an error message in the programs verbose output
void Messenger::receive | ( | ) |
calls receive on all receivers
bool Messenger::messageAvailable | ( | const base::String & | pReceiverName | ) | const throw (ComException) |
check if receiver has available message
pReceiverName | name of receiver |
ComException | receiver not found |
Message Messenger::message | ( | const base::String & | pReceiverName, | |
int | pTimeOut | |||
) | throw (ComException) |
retrieve message from receiver
pReceiverName | receiver name | |
pTimeOut | maximum time in milisecs this function will block before returning ( < 0: no timeout, funcion blocks till message is complete) |
ComException | failed to retrieve message |
void Messenger::clearMessage | ( | const base::String & | pReceiverName | ) | const throw (ComException) |
remove available message
pReceiverName | name of receiver |
ComException | receiver not found |
void Messenger::update | ( | ) | [virtual] |
update messenger
void Messenger::updateMessageListeners | ( | ) | [protected] |
message listeners
QHash<base::String, Sender*> iso::com::Messenger::mSenders [protected] |
QHash<base::String, Receiver*> iso::com::Messenger::mReceivers [protected] |
message sender repository
QMultiHash< Receiver*, MessageListener* > iso::com::Messenger::mMessageListeners [protected] |
message receiver repository