#include <IOwnCommPipe.hpp>
Public Member Functions | |
| virtual void MQUALIFIER | lock ()=0 |
| virtual void MQUALIFIER | unlock ()=0 |
| virtual void MQUALIFIER | flush ()=0 |
| virtual Retval MQUALIFIER | getMessage (IMessage *&rpMessage)=0 |
| virtual Retval MQUALIFIER | peekMessage (IMessage *&rpMessage)=0 |
| virtual bool MQUALIFIER | isEmpty () const =0 |
| virtual Int MQUALIFIER | getCount () const =0 |
The IOwnCommPipe interface defines a pipe, which is owned by some one. Through this interface a message can be read. The sender interface is defined by ICommPipe, which defines methods to send a message. This interface inherits the ICommInterface, so the owner can do both, sending and receiving through this pipe.
| virtual void MQUALIFIER zeus::IOwnCommPipe::flush | ( | ) | [pure virtual] |
This flushes the pipe. All messages and their objects will be released.
Implemented in zeus::TCommPipe, and zeus::TMappedCommPipe.
| virtual Int MQUALIFIER zeus::IOwnCommPipe::getCount | ( | ) | const [pure virtual] |
Returns the number of posted messages, which a still remaining in the pipe.
Implemented in zeus::TCommPipe.
| virtual Retval MQUALIFIER zeus::IOwnCommPipe::getMessage | ( | IMessage *& | rpMessage ) | [pure virtual] |
Returns the top message object from the pipe. The message will be removed from the pipe.
| rpMessage | : Return value of the message |
| RET_NOERROR | : Message has been successfully returned |
| RET_REQUEST_FAILED | : No message available or pipe is locked |
Implemented in zeus::TCommPipe, and zeus::TMappedCommPipe.
| virtual bool MQUALIFIER zeus::IOwnCommPipe::isEmpty | ( | ) | const [pure virtual] |
Checkes if the pipe is empty.
| true | : Pipe is empty |
| false,: | pipe is not empty |
Implemented in zeus::TCommPipe.
| virtual void MQUALIFIER zeus::IOwnCommPipe::lock | ( | ) | [pure virtual] |
This method locks the pipe. Throu a locked pipe no message can be sent or received
Implemented in zeus::TCommPipe.
| virtual Retval MQUALIFIER zeus::IOwnCommPipe::peekMessage | ( | IMessage *& | rpMessage ) | [pure virtual] |
Returns the top message object from the pipe. The message wont be removed from the pipe. To remove the message call getMessage().
| rpMessage | : Return value of the message |
| RET_NOERROR | : Message has been successfully returned |
| RET_INVALID_PARAMETER | : The msg parameter is invalid |
| RET_REQUEST_FAILED | : No message available or pipe is locked |
Implemented in zeus::TCommPipe.
| virtual void MQUALIFIER zeus::IOwnCommPipe::unlock | ( | ) | [pure virtual] |
This method unlocks the pipe. This method must be called before a communication starts using this pipe.
Implemented in zeus::TCommPipe.
