xrootd
Public Member Functions | List of all members
XrdCl::OutgoingMsgHandler Class Referenceabstract

Message status handler. More...

#include <XrdClPostMasterInterfaces.hh>

Public Member Functions

virtual ~OutgoingMsgHandler ()
 
virtual void OnStatusReady (const Message *message, Status status)=0
 The requested action has been performed and the status is available. More...
 
virtual void OnReadyToSend (Message *msg, uint16_t streamNum)
 
virtual bool IsRaw () const
 
virtual Status WriteMessageBody (int socket, uint32_t &bytesRead)
 

Detailed Description

Message status handler.

Constructor & Destructor Documentation

virtual XrdCl::OutgoingMsgHandler::~OutgoingMsgHandler ( )
inlinevirtual

Member Function Documentation

virtual bool XrdCl::OutgoingMsgHandler::IsRaw ( ) const
inlinevirtual

Determines whether the handler wants to write some data directly to the socket after the message (or message header) has been sent, WriteMessageBody will be called

virtual void XrdCl::OutgoingMsgHandler::OnReadyToSend ( Message msg,
uint16_t  streamNum 
)
inlinevirtual

Called just before the message is going to be sent through a valid connection, so that the user can still make some modifications that were impossible before (ie. protocol version dependent adjustments)

Parameters
msgmessage concerned
streamNumnumber of the stream the message will go through
virtual void XrdCl::OutgoingMsgHandler::OnStatusReady ( const Message message,
Status  status 
)
pure virtual

The requested action has been performed and the status is available.

virtual Status XrdCl::OutgoingMsgHandler::WriteMessageBody ( int  socket,
uint32_t &  bytesRead 
)
inlinevirtual

Write message body directly to a socket - called if IsRaw returns true - only socket related errors may be returned here

Parameters
socketthe socket to read from
bytesReadnumber of bytes read by the method
Returns
stOK & suDone if the whole body has been processed stOK & suRetry if more data needs to be written stError on failure

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