![]() |
MAK RTIspy API Documentation for HLA 1.3
|
Inheritance diagram for DtSmRtiConnection:
Collaboration diagram for DtSmRtiConnection:Public Member Functions | |
| DtSmRtiConnection (DtRtiSmSocket *socket) | |
| Constructors. | |
| virtual | ~DtSmRtiConnection () |
| Destructor. | |
| virtual int | send (const DtRtiMsg &msg, const MAKRti::DtInetAddr &addr=MAKRti::DtInetAddr::inaddrAny()) |
| Override DtConnection send method and assert if invoked. | |
| virtual int | send (const DtRtiMsg &msg, MAKRti::DtTransportType transport, const MAKRti::DtInetAddr &addr=MAKRti::DtInetAddr::inaddrAny(), unsigned int priority=0) |
| Send a message. Non-blocking. | |
| virtual bool | flush () |
| Send buffered messages. | |
| virtual int | getMessageNetInfo (MAKRti::DtInetAddr *addr, MAKRti::DtTransportType *trans, DtU32 *priority=NULL) |
| This method returns the size of the next available message in the shared memory queue along with additional information (e.g. | |
| virtual bool | isReliable () |
| Return true if the queue is in reliable delivery mode. | |
| virtual int | waitForMessages (MAKRti::DtTime waitTime=0.0) |
| Wait (block) for the specified time until a message can be read. | |
| virtual int | waitUntilFull (MAKRti::DtTime waitTime=0.0) |
| Wait (block) for the specified time until the shared memory is full. | |
| virtual bool | sm_shutdown (bool ruthless=false) |
| Attempt to shutdown the queue. | |
| virtual int | subscriberCount () const |
| Return count of subscribers connected to the shared memory queue. | |
Public Member Functions inherited from DtRtiConnection | |
| DtRtiConnection (DtMsgSocket *skt) | |
| Constructor. | |
| virtual | ~DtRtiConnection () |
| Destructor. | |
| virtual void | setMsgFactory (DtRtiMsgFactory *fact) |
| Set/Get the Message Factory used by this object. | |
| virtual DtRtiMsgFactory * | rtiMsgFactory () |
| virtual DtRtiMsg * | netRead (DtNetReadStatus *retCode=NULL) |
| Note: netRead() creates a new DtRtiMsg using the message factory Caller is responsible for deleting it when through. | |
| virtual int | isOk () |
| Return true if the status of the connection is OK. | |
| virtual void | setCheckVersion (bool enableCheckVersion) |
| Set/get whether to check message version. | |
| virtual bool | checkVersion () const |
| virtual void | disableCheckSize () |
| Disable message size check. | |
| virtual void | enableCheckSize () |
| Enable message size check. | |
| virtual void | setFedExName (const MAKRti::DtString &newFedExName) |
| Set/Get federation execution name. NULL means "all". | |
| virtual const MAKRti::DtString & | fedExName () const |
| virtual void | setFedExHandle (int handle) |
| Set/Get federation execution handle. 0 means "all". | |
| virtual int | fedExHandle () const |
| virtual void | setFederateHandle (DtFederationHandle handle) |
| Set/Get federate handle. | |
| virtual DtFederationHandle | federateHandle () const |
| virtual void | setConnId (unsigned long connId) |
| Set/Get the connection ID assigned to the connection. | |
| virtual unsigned long | connId () const |
| virtual DtMsgSocket * | socket () |
| Returns our socket. | |
Protected Types | |
| typedef std::list< DtRtiMsg * > | DtOutboundPendingList |
| for reliable connections only | |
Protected Attributes | |
| DtRtiSmSocket * | mySmSocket |
| DtOutboundPendingList | myObPendingMessages |
Protected Attributes inherited from DtRtiConnection | |
| MAKRti::DtString | myFedExName |
| int | myFedExHandle |
| DtFederationHandle | myFedHandle |
| DtMsgSocket * | mySocket |
| DtRtiMsgFactory * | myMsgFact |
| unsigned long | myReceivedMsgCount |
| bool | myCheckSize |
| bool | myCheckVersion |
| unsigned int | myWaitEventIndex |
| unsigned long | myConnId |
| Win32 only. | |
Additional Inherited Members | |
Protected Member Functions inherited from DtRtiConnection | |
| void | init (DtMsgSocket *s) |
|
protected |
for reliable connections only
| DtSmRtiConnection::DtSmRtiConnection | ( | DtRtiSmSocket * | socket | ) |
Constructors.
|
virtual |
Destructor.
|
virtual |
Send buffered messages.
Returns indication of whether the flush is complete or incomplete.
Reimplemented from DtRtiConnection.
References DtSMQ_MSG_BESTEFFORT, DtSMQ_MSG_RELIABLE, DtRtiSmSocket::flush(), myObPendingMessages, mySmSocket, and DtRtiSmSocket::sendMessage().
Referenced by DtSmConnectionMgr::processConnections().
|
virtual |
This method returns the size of the next available message in the shared memory queue along with additional information (e.g.
destination address, transport method, and priority) needed by a forwarder or shared memory queue manager net I/O handler to pass messages to a network.
References DtSMQ_MSG_RELIABLE, DtSMQ_PRIO_MASK, DtRtiSmSocket::getMsgTransportInfo(), and mySmSocket.
|
virtual |
Return true if the queue is in reliable delivery mode.
References mySmSocket, and DtRtiSmSocket::queueIsReliable().
Referenced by DtSmConnectionMgr::send().
|
virtual |
Override DtConnection send method and assert if invoked.
Shared memory connections require the additional transport parameter at a minimum so the shared memory queue manager can forward message via the appropriate net I/O socket
Reimplemented from DtRtiConnection.
Referenced by DtSmConnectionMgr::send().
|
virtual |
Send a message. Non-blocking.
References DtRtiMsg::cloneWithTransport(), DtSMQ_MSG_BESTEFFORT, DtSMQ_MSG_RELIABLE, DtSMQ_PRIO_MASK, DtUseFedObservers, DtNetMsgHeader::flags, DtSmSocket__rti__::isOpen(), myObPendingMessages, mySmSocket, DtRtiMsg::netHeader(), DtRtiSmSocket::queueIsReliable(), and DtRtiSmSocket::sendMessage().
|
virtual |
Attempt to shutdown the queue.
This should only be invoked by the queue manager before destroying the shared memory pool.
References mySmSocket, and DtSmSocket__rti__::shutdownQueue().
Referenced by DtSmConnectionMgr::sm_shutdown().
|
virtual |
Return count of subscribers connected to the shared memory queue.
References mySmSocket, and DtSmSocket__rti__::subscriberCount().
Referenced by DtSmConnectionMgr::subscriberCount().
|
virtual |
Wait (block) for the specified time until a message can be read.
Return status: 0 if messages are ready, > 0 if wait expired, or < 0 if error
References mySmSocket, and DtRtiSmSocket::waitForMessages().
Referenced by DtSmConnectionMgr::wait().
|
virtual |
Wait (block) for the specified time until the shared memory is full.
Return status: 0 if full, > 0 if wait expired, or < 0 if error
References mySmSocket, and DtRtiSmSocket::waitUntilFull().
|
protected |
|
protected |
Referenced by flush(), getMessageNetInfo(), isReliable(), send(), sm_shutdown(), subscriberCount(), waitForMessages(), and waitUntilFull().