WSF
WsfXIO_MessageRequest Class Referenceabstract

Requests copies of messages sent/received by a platform. More...

#include <WsfXIO_MessageService.hpp>

Inheritance diagram for WsfXIO_MessageRequest:
Collaboration diagram for WsfXIO_MessageRequest:

Public Member Functions

 WsfXIO_MessageRequest (WsfXIO_Connection *aConnectionPtr, int aPlatformIndex, bool aReceivedMessages, bool aTransmittedMessages, bool aIsReliable=true)
virtual void HandleMessage (WsfXIO_MessagePkt &aPkt)=0
 Override this method to handle messages.
Public Member Functions inherited from WsfXIO_Request
 WsfXIO_Request (WsfXIO_Connection *aConnectionPtr, bool aIsReliable=true)
virtual void HandleResponse (WsfXIO_ResponsePkt &aPkt)
void SendRequest (WsfXIO_RequestDataPkt &aPkt)
 Sends the request to the remote application.
WsfXIO_ConnectionGetConnection () const
 Returns the connection to the application from which data is requested.
bool IsReliable () const
 Returns 'true' if data for this request is to be sent reliably.
int GetRequestId () const
 Returns the request's locally unique ID.
void SetRequestManager (WsfXIO_RequestManager *aRequestManagerPtr)
 Sets the owner of this request.
void SendResponse (WsfXIO_ResponsePkt &aPkt)

Additional Inherited Members

Protected Member Functions inherited from WsfXIO_Request
virtual ~WsfXIO_Request ()
void SetRequestId (unsigned int aRequestId)
void SetRemotelyDestroyed ()
bool IsRemotelyDestroyed () const
void SetIsReliable (bool aIsReliable)

Detailed Description

Requests copies of messages sent/received by a platform.

Constructor & Destructor Documentation

◆ WsfXIO_MessageRequest()

WsfXIO_MessageRequest::WsfXIO_MessageRequest ( WsfXIO_Connection * aConnectionPtr,
int aPlatformIndex,
bool aReceivedMessages,
bool aTransmittedMessages,
bool aIsReliable = true )

Create request for messages

Parameters
aConnectionPtrPointer to an XIO connection
aPlatformIndexThe index of the platform sending or receiving the messages
aReceivedMessages'true' if received messages are requested.
aTransmittedMessages'true' if transmitted messages are requested.
aIsReliable'true' a reliable protocol is to be used.
Note
This request must be added to a WsfXIO_RequestManager

References WsfXIO_Request::WsfXIO_Request().

Member Function Documentation

◆ HandleMessage()

virtual void WsfXIO_MessageRequest::HandleMessage ( WsfXIO_MessagePkt & aPkt)
pure virtual

Override this method to handle messages.


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved