XrdCl::OutgoingMsgHandler Class Reference

Message status handler. More...

#include <XrdClPostMasterInterfaces.hh>

List of all members.

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.
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 (  )  [inline, virtual]

Member Function Documentation

virtual bool XrdCl::OutgoingMsgHandler::IsRaw (  )  const [inline, virtual]

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 
) [inline, virtual]

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:
msg message concerned
streamNum number 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 
) [inline, virtual]

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

Parameters:
socket the socket to read from
bytesRead number 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:

Generated on 14 Dec 2017 for xrootd by  doxygen 1.6.1