XRootD
XrdSsiRespInfoMsg Class Referenceabstract

#include <XrdSsiRespInfo.hh>

+ Collaboration diagram for XrdSsiRespInfoMsg:

Public Member Functions

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

Protected Member Functions

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

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.

Definition at line 86 of file XrdSsiRespInfo.hh.

Constructor & Destructor Documentation

◆ XrdSsiRespInfoMsg()

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

Contructor

Parameters
msgPPointer to the message buffer.
mlenlength of the message.

Definition at line 117 of file XrdSsiRespInfo.hh.

118  : msgBuf(msgP), msgLen(mlen) {}

◆ ~XrdSsiRespInfoMsg()

virtual XrdSsiRespInfoMsg::~XrdSsiRespInfoMsg ( )
inlineprotectedvirtual

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

Definition at line 126 of file XrdSsiRespInfo.hh.

126 {}

Member Function Documentation

◆ GetMsg()

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

Obtain the message associated with the message object.

Parameters
mlenholds 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

Definition at line 99 of file XrdSsiRespInfo.hh.

99 {mlen = msgLen; return msgBuf;}

References msgBuf, and msgLen.

Referenced by XrdSsiFileReq::Alert(), and XrdSsiAlert::SetInfo().

+ Here is the caller graph for this function:

◆ RecycleMsg()

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
sentWhen true, the message was sent. Otherwise, it was not sent.

Referenced by XrdSsiFileReq::Alert(), XrdSsiRequest::Alert(), XrdSsiResponder::Alert(), and XrdSsiAlert::Recycle().

+ Here is the caller graph for this function:

Member Data Documentation

◆ msgBuf

char* XrdSsiRespInfoMsg::msgBuf
protected

Definition at line 128 of file XrdSsiRespInfo.hh.

Referenced by GetMsg().

◆ msgLen

int XrdSsiRespInfoMsg::msgLen
protected

Definition at line 129 of file XrdSsiRespInfo.hh.

Referenced by GetMsg().


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