XrdCl::MsgHandler Class Reference

Message handler. More...

#include <XrdClPostMasterInterfaces.hh>

Inheritance diagram for XrdCl::MsgHandler:

Public Types
enum	Action {   None = 0x0000 , Nop = 0x0001 , Ignore = 0x0002 , RemoveHandler = 0x0004 ,   Raw = 0x0008 , NoProcess = 0x0010 , Corrupted = 0x0020 , More = 0x0040 }
	Actions to be taken after a message is processed by the handler. More...
enum	StreamEvent { Ready = 1 , Broken = 2 , Timeout = 3 , FatalError = 4 }
	Events that may have occurred to the stream. More...

Public Member Functions
virtual	~MsgHandler ()
	Event types that the message handler may receive.
virtual uint16_t	Examine (std::shared_ptr< Message > &msg)=0
virtual uint16_t	InspectStatusRsp ()=0
virtual uint16_t	GetSid () const =0
virtual void	Process ()
virtual XRootDStatus	ReadMessageBody (Message *msg, Socket *socket, uint32_t &bytesRead)
virtual uint8_t	OnStreamEvent (StreamEvent event, XRootDStatus status)
virtual void	OnStatusReady (const Message *message, XRootDStatus status)=0
	The requested action has been performed and the status is available.
virtual void	OnReadyToSend (Message *msg)
virtual bool	IsRaw () const
virtual XRootDStatus	WriteMessageBody (Socket *socket, uint32_t &bytesWritten)
virtual time_t	GetExpiration ()=0

Detailed Description

Message handler.

Member Enumeration Documentation

Action

enum XrdCl::MsgHandler::Action

Actions to be taken after a message is processed by the handler.

Enumerator
None
Nop	A place holder.
Ignore	Ignore the message.
RemoveHandler	Remove the handler from the notification list
Raw	the handler is interested in reading the message body directly from the socket
NoProcess	don't call the processing callback even if the message belongs to this handler
Corrupted	the handler discovered that the message header is corrupted, we will have to tear down the socket
More	there are more (non-raw) data to be read

StreamEvent

enum XrdCl::MsgHandler::StreamEvent

Events that may have occurred to the stream.

Enumerator
Ready	The stream has become connected.
Broken	The stream is broken.
Timeout	The declared timeout has occurred.
FatalError	Stream has been broken and won't be recovered.

Constructor & Destructor Documentation

~MsgHandler()

virtual XrdCl::MsgHandler::~MsgHandler ( )

inlinevirtual

Event types that the message handler may receive.

Member Function Documentation

Examine()

virtual uint16_t XrdCl::MsgHandler::Examine ( std::shared_ptr< Message > &  msg )

pure virtual

Examine an incoming message, and decide on the action to be taken

Parameters

msg	the message, may be zero if receive failed

Returns

action type that needs to be take wrt the message and the handler

Implemented in XrdCl::XRootDMsgHandler.

GetExpiration()

virtual time_t XrdCl::MsgHandler::GetExpiration ( )

pure virtual

Implemented in XrdCl::XRootDMsgHandler.

GetSid()

virtual uint16_t XrdCl::MsgHandler::GetSid ( ) const

pure virtual

Get handler sid

return sid of the corresponding request, otherwise 0

Implemented in XrdCl::XRootDMsgHandler.

InspectStatusRsp()

virtual uint16_t XrdCl::MsgHandler::InspectStatusRsp ( )

pure virtual

Reexamine the incoming message, and decide on the action to be taken

In case of kXR_status the message can be only fully examined after reading the whole body (without raw data).

Parameters

msg	the message, may be zero if receive failed

Returns

action type that needs to be take wrt the message and the handler

Implemented in XrdCl::XRootDMsgHandler.

IsRaw()

virtual bool XrdCl::MsgHandler::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::AsyncMsgWriter::Write().

OnReadyToSend()

virtual void XrdCl::MsgHandler::OnReadyToSend ( Message *  msg )

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

OnStatusReady()

virtual void XrdCl::MsgHandler::OnStatusReady ( const Message *  message, XRootDStatus  status  )

pure virtual

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

Implemented in XrdCl::XRootDMsgHandler.

OnStreamEvent()

virtual uint8_t XrdCl::MsgHandler::OnStreamEvent ( StreamEvent  event, XRootDStatus  status  )

inlinevirtual

Handle an event other that a message arrival

Parameters

event	type of the event
status	status info

Returns

Action::RemoveHandler or 0

Reimplemented in XrdCl::XRootDMsgHandler.

Process()

virtual void XrdCl::MsgHandler::Process ( )

inlinevirtual

Process the message if it was "taken" by the examine action

Parameters

msg	the message to be processed

Reimplemented in XrdCl::XRootDMsgHandler.

Referenced by XrdCl::Stream::HandleIncMsgJob::Run().

ReadMessageBody()

virtual XRootDStatus XrdCl::MsgHandler::ReadMessageBody ( Message *  msg, Socket *  socket, uint32_t &  bytesRead  )

inlinevirtual

Read message body directly from a socket - called if Examine returns Raw flag - only socket related errors may be returned here

Parameters

msg	the corresponding message header
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 is needed stError on failure

Reimplemented in XrdCl::XRootDMsgHandler.

References XrdCl::stOK, and XrdCl::suDone.

Referenced by XrdCl::AsyncMsgReader::Read().

WriteMessageBody()

virtual XRootDStatus XrdCl::MsgHandler::WriteMessageBody ( Socket *  socket, uint32_t &  bytesWritten  )

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
bytesWritten	number of bytes written 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::AsyncMsgWriter::Write().

---

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

• XrdClPostMasterInterfaces.hh