zeus::ICommPipe Class Reference
#include <ICommPipe.hpp>
Inheritance diagram for zeus::ICommPipe:
Public Member Functions | |
| virtual Retval MQUALIFIER | sendMessage (IMessage &rMessage, Uint64 ldInitTime=0)=0 |
| virtual Uint MQUALIFIER | getPriority () const =0 |
| virtual void MQUALIFIER | getPipeName (IString &rName) const =0 |
| virtual void MQUALIFIER | getCellName (IString &rName) const =0 |
| virtual bool MQUALIFIER | isLocked () const =0 |
| virtual bool MQUALIFIER | hasRemoteAccess () const =0 |
Detailed Description
Das ICommPipe Interface wird als Zugriffsinterface zu einer FIFO Pipe definiert. Hier koennen asynchron Meldungen abgesetzt werden.Member Function Documentation
| virtual Retval MQUALIFIER zeus::ICommPipe::sendMessage | ( | IMessage & | rMessage, | |
| Uint64 | ldInitTime = 0 | |||
| ) | [pure virtual] |
Eine Messages wird gesendet.
- Parameters:
-
rMessage : Referenz auf eine Message ldInitTime : Initialzeit der Message
- Return values:
-
RET_NOERROR : Message has been sent RET_REQUEST_FAILED : Could not send message of any reason RET_REMOTECALL_ERROR : Could not send message to the remote system RET_INTERNAL_ERROR : Could not send message because of internal error. In this case the pipe should be removed.
Implemented in zeus::TCommPipe, zeus::TCommPipe_Stub, and zeus::TMappedCommPipe.
| virtual Uint MQUALIFIER zeus::ICommPipe::getPriority | ( | ) | const [pure virtual] |
Ermitteln der Prioritaet
- Returns:
- Prioritaet
Implemented in zeus::TCommPipe, and zeus::TCommPipe_Stub.
| virtual void MQUALIFIER zeus::ICommPipe::getPipeName | ( | IString & | rName | ) | const [pure virtual] |
Gets the Name of the pipe
- Parameters:
-
rName : Return parameter of the name
Implemented in zeus::TCommPipe, and zeus::TCommPipe_Stub.
| virtual void MQUALIFIER zeus::ICommPipe::getCellName | ( | IString & | rName | ) | const [pure virtual] |
Gets the Name of the owner cell
- Parameters:
-
rName : Return parameter of the name
Implemented in zeus::TCommPipe, and zeus::TCommPipe_Stub.
| virtual bool MQUALIFIER zeus::ICommPipe::isLocked | ( | ) | const [pure virtual] |
Checks if the pipe is open or locked
- Return values:
-
false : open and ready for communication true : locked
Implemented in zeus::TCommPipe, and zeus::TCommPipe_Stub.
| virtual bool MQUALIFIER zeus::ICommPipe::hasRemoteAccess | ( | ) | const [pure virtual] |
Checks if the pipe has a remote access.
- Return values:
-
true : Remote access available false,: No remote access
Implemented in zeus::TCommPipe, and zeus::TCommPipe_Stub.
The documentation for this class was generated from the following file: