xrootd
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
XrdCl::Poller Class Referenceabstract

Interface for socket pollers. More...

#include <XrdClPoller.hh>

Inheritance diagram for XrdCl::Poller:
Inheritance graph
[legend]

Public Member Functions

virtual ~Poller ()
 Destructor. More...
 
virtual bool Initialize ()=0
 Initialize the poller. More...
 
virtual bool Finalize ()=0
 Finalize the poller. More...
 
virtual bool Start ()=0
 Start polling. More...
 
virtual bool Stop ()=0
 Stop polling. More...
 
virtual bool AddSocket (Socket *socket, SocketHandler *handler)=0
 
virtual bool RemoveSocket (Socket *socket)=0
 Remove the socket. More...
 
virtual bool EnableReadNotification (Socket *socket, bool notify, uint16_t timeout=60)=0
 
virtual bool EnableWriteNotification (Socket *socket, bool notify, uint16_t timeout=60)=0
 
virtual bool IsRegistered (Socket *socket)=0
 Check whether the socket is registered with the poller. More...
 
virtual bool IsRunning () const =0
 Is the event loop running? More...
 

Detailed Description

Interface for socket pollers.

Constructor & Destructor Documentation

virtual XrdCl::Poller::~Poller ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual bool XrdCl::Poller::AddSocket ( Socket socket,
SocketHandler handler 
)
pure virtual

Add socket to the polling loop

Parameters
socketthe socket
handlerobject handling the events

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::EnableReadNotification ( Socket socket,
bool  notify,
uint16_t  timeout = 60 
)
pure virtual

Notify the handler about read events

Parameters
socketthe socket
notifyspecify if the handler should be notified
timeoutif no read event occurred after this time a timeout event will be generated

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::EnableWriteNotification ( Socket socket,
bool  notify,
uint16_t  timeout = 60 
)
pure virtual

Notify the handler about write events

Parameters
socketthe socket
notifyspecify if the handler should be notified
timeoutif no write event occurred after this time a timeout event will be generated

Implemented in XrdCl::PollerBuiltIn.

Referenced by XrdCl::AsyncSocketHandler::DisableUplink(), and XrdCl::AsyncSocketHandler::EnableUplink().

virtual bool XrdCl::Poller::Finalize ( )
pure virtual

Finalize the poller.

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::Initialize ( )
pure virtual

Initialize the poller.

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::IsRegistered ( Socket socket)
pure virtual

Check whether the socket is registered with the poller.

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::IsRunning ( ) const
pure virtual

Is the event loop running?

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::RemoveSocket ( Socket socket)
pure virtual

Remove the socket.

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::Start ( )
pure virtual

Start polling.

Implemented in XrdCl::PollerBuiltIn.

virtual bool XrdCl::Poller::Stop ( )
pure virtual

Stop polling.

Implemented in XrdCl::PollerBuiltIn.


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