#include <CommModule.h>
Public Member Functions | |
CommModule () | |
constructor | |
bool | storePacketString (string &packetString) |
Store a packet (interface for the listener). | |
void | requestBox (int task) |
Request a box for the task (interface for the task). | |
int | requestBox (string taskName) |
Request a box for the task (interface for the task). | |
bool | receive (int task, CommBox &packets) |
Return a vector of packets to the task (interface for the task). | |
void | receiveAck (int task, CommBox &packets) |
Acknowledge of the received packets (interface for the task). | |
void | send (CommPacket packet) |
Send a packet (interface for the task). | |
virtual bool | sendPacketString (string &packetString, CommNode recipient)=0 |
Send a packetString. | |
string | print () |
Print function. | |
Protected Attributes | |
CommModulePar * | _par |
CommModuleVar * | _var |
bool | on |
every inherited class constructor must set this flag to true |
MipResources::CommModule::CommModule | ( | ) | [inline] |
constructor
bool MipResources::CommModule::storePacketString | ( | string & | packetString | ) |
Store a packet (interface for the listener).
packetString | a string containing a serialized CommPacket |
void MipResources::CommModule::requestBox | ( | int | task | ) |
Request a box for the task (interface for the task).
task | the task number (plate) |
int MipResources::CommModule::requestBox | ( | string | taskName | ) |
Request a box for the task (interface for the task).
task | the task number (plate) |
bool MipResources::CommModule::receive | ( | int | task, | |
CommBox & | packets | |||
) |
Return a vector of packets to the task (interface for the task).
task | the task number (plate) | |
[out] | packets | the CommBox containing pointers to the packets to receive |
void MipResources::CommModule::receiveAck | ( | int | task, | |
CommBox & | packets | |||
) |
Acknowledge of the received packets (interface for the task).
task | the task number (plate) | |
[out] | packets | the CommBox containing pointers to the packets just received |
void MipResources::CommModule::send | ( | CommPacket | packet | ) |
Send a packet (interface for the task).
packet | the packet to send |
virtual bool MipResources::CommModule::sendPacketString | ( | string & | packetString, | |
CommNode | recipient | |||
) | [pure virtual] |
Send a packetString.
packetString | a string containing a serialized CommPacket | |
recipient | recipient of the packet |
Implemented in MipResources::DirectStreamCommModule, and MipResources::IPCommModule.
string MipResources::CommModule::print | ( | ) |
Print function.
This function returns a string that can be printed, with all the informations contained in the class.
Reimplemented from MipResources::Resource.
CommModulePar* MipResources::CommModule::_par [protected] |
CommModuleVar* MipResources::CommModule::_var [protected] |
bool MipResources::CommModule::on [protected] |
every inherited class constructor must set this flag to true