XrdSsiRespInfoMsg Class Reference

#include <XrdSsiRespInfo.hh>

List of all members.

Public Member Functions

char * GetMsg (int &mlen)
virtual void RecycleMsg (bool sent=true)=0
 XrdSsiRespInfoMsg (char *msgP, int mlen)

Protected Member Functions

virtual ~XrdSsiRespInfoMsg ()
 Destructor. This object may not be deleted. Use Recycle() instead.

Protected Attributes

char * msgBuf
int msgLen

Detailed Description

The RespInfoMsg class describes an async response message sent to the XrdSsiRequest::Alert() method. It encapsulates the message sent and must recover any resources used by the message when RecycleMsg() is called.


Constructor & Destructor Documentation

XrdSsiRespInfoMsg::XrdSsiRespInfoMsg ( char *  msgP,
int  mlen 
) [inline]

Contructor

Parameters:
msgP Pointer to the message buffer.
mlen length of the message.
virtual XrdSsiRespInfoMsg::~XrdSsiRespInfoMsg (  )  [inline, protected, virtual]

Destructor. This object may not be deleted. Use Recycle() instead.


Member Function Documentation

char* XrdSsiRespInfoMsg::GetMsg ( int &  mlen  )  [inline]

Obtain the message associated with the message object.

Parameters:
mlen holds the length of the message after the call.
Returns:
=0 No message available, dlen has been set to zero.
!0 Pointer to the buffer holding the message, dlen has the length

References msgBuf, and msgLen.

virtual void XrdSsiRespInfoMsg::RecycleMsg ( bool  sent = true  )  [pure virtual]

Release resources used by the message. This method must be called after the message is processed by the XrdSsiRequest::Alert() method.

Parameters:
sent When true, the message was sent. Otherwise, it was not sent.

Referenced by XrdSsiRequest::Alert().


Member Data Documentation

char* XrdSsiRespInfoMsg::msgBuf [protected]

Referenced by GetMsg().

int XrdSsiRespInfoMsg::msgLen [protected]

Referenced by GetMsg().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 13 May 2020 for xrootd by  doxygen 1.6.1