conscience_core::communication::CscMessagingRequestContext Class Reference

#include <CscMessagingRequestContext.h>

Public Member Functions
string	getRemoteIp () const
CscMessagingProtocol	getProtocol () const
CscMessagingPort	getRemotePort () const
void	setRemotePortForUdp (CscMessagingPort remotePort)
optional< string >	getRemoteUdpClientId () const
void	setRemoteUdpClientId (optional< string > remoteUdpClientId)
TcpClient *	getTcpClient () const
	~CscMessagingRequestContext ()
	operator string () const
string	toString () const
bool	shouldAutoCloseAfterResponse () const
void	setAutoCloseAfterResponse (bool enabled)

Static Public Member Functions
static ptr< CscMessagingRequestContext >	forUdp (const string &remoteIp, CscMessagingPort remotePort)
static ptr< CscMessagingRequestContext >	forTcp (TcpClient *tcpClient)
static ptr< CscMessagingRequestContext >	forTcp (const string &remoteIpAddress, CscMessagingPort remotePort)

Public Attributes
optional< string >	lastCommandResponse = {}
optional< unsigned >	sendTimoutSeconds = {}
ptr< bool >	destroyed = nullptr

Constructor & Destructor Documentation

~CscMessagingRequestContext()

conscience_core::communication::CscMessagingRequestContext::~CscMessagingRequestContext

(

)

Member Function Documentation

forTcp() [1/2]

ptr< CscMessagingRequestContext > conscience_core::communication::CscMessagingRequestContext::forTcp ( const string &  remoteIpAddress, CscMessagingPort  remotePort  )

static

forTcp() [2/2]

ptr< CscMessagingRequestContext > conscience_core::communication::CscMessagingRequestContext::forTcp ( TcpClient *  tcpClient )

static

forUdp()

ptr< CscMessagingRequestContext > conscience_core::communication::CscMessagingRequestContext::forUdp ( const string &  remoteIp, CscMessagingPort  remotePort  )

static

getProtocol()

CscMessagingProtocol conscience_core::communication::CscMessagingRequestContext::getProtocol

(

)

const

getRemoteIp()

string conscience_core::communication::CscMessagingRequestContext::getRemoteIp

(

)

const

getRemotePort()

CscMessagingPort conscience_core::communication::CscMessagingRequestContext::getRemotePort

(

)

const

getRemoteUdpClientId()

optional< string > conscience_core::communication::CscMessagingRequestContext::getRemoteUdpClientId

(

)

const

getTcpClient()

TcpClient * conscience_core::communication::CscMessagingRequestContext::getTcpClient

(

)

const

operator string()

conscience_core::communication::CscMessagingRequestContext::operator string

(

)

const

setAutoCloseAfterResponse()

void conscience_core::communication::CscMessagingRequestContext::setAutoCloseAfterResponse

(

bool

enabled

)

Note

CS-2448 we enable ability to exchange multiple messages on a single TCP connection, but only on-demand for now

This should only be called whend __CSC_COM_SET_AUTOCLOSE=false is received by CscMessageReader

setRemotePortForUdp()

void conscience_core::communication::CscMessagingRequestContext::setRemotePortForUdp

(

CscMessagingPort

remotePort

)

setRemoteUdpClientId()

void conscience_core::communication::CscMessagingRequestContext::setRemoteUdpClientId

(

optional< string >

remoteUdpClientId

)

shouldAutoCloseAfterResponse()

bool conscience_core::communication::CscMessagingRequestContext::shouldAutoCloseAfterResponse

(

)

const

Note

CS-2448 we enable ability to exchange multiple messages on a single TCP connection, but only on-demand for now

toString()

string conscience_core::communication::CscMessagingRequestContext::toString

(

)

const

Member Data Documentation

destroyed

ptr<bool> conscience_core::communication::CscMessagingRequestContext::destroyed = nullptr

if used in the context of a messaging manager, tell if it has been destroyed

lastCommandResponse

optional<string> conscience_core::communication::CscMessagingRequestContext::lastCommandResponse = {}

sendTimoutSeconds

optional<unsigned> conscience_core::communication::CscMessagingRequestContext::sendTimoutSeconds = {}

---

The documentation for this class was generated from the following files:

• Communication/CscMessagingRequestContext.h
• Communication/CscMessagingRequestContext.cpp