XrdCl::SocketHandler Class Reference

Interface. More...

#include <XrdClPoller.hh>

Inheritance diagram for XrdCl::SocketHandler:

Collaboration diagram for XrdCl::SocketHandler:

Public Types
enum	EventType {   ReadyToRead = 0x01 ,   ReadTimeOut = 0x02 ,   ReadyToWrite = 0x04 ,   WriteTimeOut = 0x08 }
	Event type. More...

Public Member Functions
virtual	~SocketHandler ()
virtual void	Event (uint8_t type, Socket *socket)=0
	Called when an event occurred on a given socket.
virtual void	Finalize ()
	Finalizer.
virtual void	Initialize (Poller *)
	Initializer.

Static Public Member Functions
static std::string	EventTypeToString (uint8_t event)
	Translate the event type to a string.

Detailed Description

Interface.

Definition at line 33 of file XrdClPoller.hh.

Member Enumeration Documentation

EventType

enum XrdCl::SocketHandler::EventType

Event type.

Enumerator
ReadyToRead	New data has arrived.
ReadTimeOut	Read timeout.
ReadyToWrite	Writing won't block.
WriteTimeOut	Write timeout.

Definition at line 39 of file XrdClPoller.hh.

      {
        ReadyToRead  = 0x01,  
        ReadTimeOut  = 0x02,  
        ReadyToWrite = 0x04,  
        WriteTimeOut = 0x08   
      };

Constructor & Destructor Documentation

~SocketHandler()

virtual XrdCl::SocketHandler::~SocketHandler ( )

inlinevirtual

Definition at line 50 of file XrdClPoller.hh.

{}

Member Function Documentation

Event()

virtual void XrdCl::SocketHandler::Event ( uint8_t type, Socket * socket )

pure virtual

Called when an event occurred on a given socket.

Implemented in XrdCl::AsyncSocketHandler.

EventTypeToString()

std::string XrdCl::SocketHandler::EventTypeToString ( uint8_t event )

inlinestatic

Translate the event type to a string.

Definition at line 71 of file XrdClPoller.hh.

      {
        std::string ev;
        if( event & ReadyToRead )  ev += "ReadyToRead|";
        if( event & ReadTimeOut )  ev += "ReadTimeOut|";
        if( event & ReadyToWrite ) ev += "ReadyToWrite|";
        if( event & WriteTimeOut ) ev += "WriteTimeOut|";
        ev.erase( ev.length()-1, 1) ;
        return ev;
      }

References ReadTimeOut, ReadyToRead, ReadyToWrite, and WriteTimeOut.

Finalize()

virtual void XrdCl::SocketHandler::Finalize ( )

inlinevirtual

Finalizer.

Definition at line 60 of file XrdClPoller.hh.

{};

Initialize()

virtual void XrdCl::SocketHandler::Initialize ( Poller * )

inlinevirtual

Initializer.

Definition at line 55 of file XrdClPoller.hh.

{}

Referenced by XrdCl::PollerBuiltIn::AddSocket().

Here is the caller graph for this function:

---

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

• XrdClPoller.hh