XrdCl::OutgoingMsgHandler Class Reference

Message status handler. More...

#include <XrdClPostMasterInterfaces.hh>

Inheritance diagram for XrdCl::OutgoingMsgHandler:

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

Reimplemented in XrdCl::XRootDMsgHandler.

Referenced by XrdCl::AsyncSocketHandler::OnWrite().

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

msg	message concerned
streamNum	number of the stream the message will go through

Referenced by XrdCl::Stream::OnReadyToWrite().

virtual void XrdCl::OutgoingMsgHandler::OnStatusReady ( const Message *  message, Status  status  )

pure virtual

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

Implemented in XrdCl::XRootDMsgHandler.

Referenced by XrdCl::Stream::OnMessageSent().

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

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

Reimplemented in XrdCl::XRootDMsgHandler.

Referenced by XrdCl::AsyncSocketHandler::OnWrite().

---

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

• XrdClPostMasterInterfaces.hh