xrootd: XrdCl::PollerLibEvent Class Reference

xrootd

A poller implementation using libEvent underneath. More...

#include <XrdClPollerLibEvent.hh>

Inheritance diagram for XrdCl::PollerLibEvent:

Inheritance graph

Collaboration diagram for XrdCl::PollerLibEvent:

Collaboration graph

List of all members.

Public Member Functions
	PollerLibEvent ()
	Constructor.
virtual bool	Initialize ()
	Initialize the poller.
virtual bool	Finalize ()
	Finalize the poller.
virtual bool	Start ()
	Start polling.
virtual bool	Stop ()
	Stop polling.
virtual bool	AddSocket (Socket socket, SocketHandler handler)
virtual bool	RemoveSocket (Socket *socket)
	Remove the socket.
virtual bool	EnableReadNotification (Socket *socket, bool notify, uint16_t timeout=60)
virtual bool	EnableWriteNotification (Socket *socket, bool notify, uint16_t timeout=60)
virtual bool	IsRegistered (Socket *socket)
	Check whether the socket is registered with the poller.
virtual bool	IsRunning () const
	Is the event loop running?
int	RunEventLoop ()
	Run the libevent event loop.
Public Member Functions inherited from XrdCl::Poller
virtual	~Poller ()
	Destructor.

Private Types
typedef std::map< const Socket , void >	SocketMap

Private Attributes
SocketMap	pSocketMap
XrdSysMutex	pMutex
event_base *	pEventBase
pthread_t	pPollerThread
bool	pPollerThreadRunning

Detailed Description

A poller implementation using libEvent underneath.

Member Typedef Documentation

typedef std::map<const Socket *, void *> XrdCl::PollerLibEvent::SocketMap

private

Constructor & Destructor Documentation

XrdCl::PollerLibEvent::PollerLibEvent ( )

inline

Constructor.

Member Function Documentation

bool XrdCl::PollerLibEvent::AddSocket	(	Socket *	socket,
		SocketHandler *	handler
	)

virtual

Add socket to the polling loop

Parameters:

socket	the socket
handler	object handling the events

Implements XrdCl::Poller.

References XrdCl::Socket::Connected, XrdCl::Socket::Connecting, XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), XrdCl::Socket::GetName(), XrdCl::Socket::GetStatus(), XrdCl::SocketHandler::Initialize(), pMutex, XrdCl::PollerMsg, pSocketMap, and XrdCl::Log::Warning().

bool XrdCl::PollerLibEvent::EnableReadNotification	(	Socket *	socket,
		bool	notify,
		uint16_t	timeout = `60`
	)

virtual

Notify the handler about read events

Parameters:

socket	the socket
notify	specify if the handler should be notified
timeout	if no read event occurred after this time a timeout event will be generated

Implements XrdCl::Poller.

References XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::Socket::GetFD(), XrdCl::DefaultEnv::GetLog(), XrdCl::Socket::GetName(), pEventBase, pMutex, XrdCl::PollerMsg, pSocketMap, ReadEventCallback(), and XrdCl::Log::Warning().

bool XrdCl::PollerLibEvent::EnableWriteNotification	(	Socket *	socket,
		bool	notify,
		uint16_t	timeout = `60`
	)

virtual

Notify the handler about write events

Parameters:

socket	the socket
notify	specify if the handler should be notified
timeout	if no write event occurred after this time a timeout event will be generated

Implements XrdCl::Poller.

References XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::Socket::GetFD(), XrdCl::DefaultEnv::GetLog(), XrdCl::Socket::GetName(), pEventBase, pMutex, XrdCl::PollerMsg, pSocketMap, XrdCl::Log::Warning(), and WriteEventCallback().

bool XrdCl::PollerLibEvent::Finalize ( )

virtual

Finalize the poller.

Implements XrdCl::Poller.

References IsRunning(), pEventBase, pSocketMap, and Stop().

bool XrdCl::PollerLibEvent::Initialize ( )

virtual

Initialize the poller.

Implements XrdCl::Poller.

References XrdCl::Log::Debug(), XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), HandleLogMessage(), pEventBase, and XrdCl::PollerMsg.

bool XrdCl::PollerLibEvent::IsRegistered ( Socket * socket )

virtual

Check whether the socket is registered with the poller.

Implements XrdCl::Poller.

References pMutex, and pSocketMap.

virtual bool XrdCl::PollerLibEvent::IsRunning ( ) const

inlinevirtual

Is the event loop running?

Implements XrdCl::Poller.

References pPollerThreadRunning.

Referenced by Finalize().

bool XrdCl::PollerLibEvent::RemoveSocket ( Socket * socket )

virtual

Remove the socket.

Implements XrdCl::Poller.

References XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), XrdCl::Socket::GetName(), pMutex, XrdCl::PollerMsg, and pSocketMap.

int XrdCl::PollerLibEvent::RunEventLoop ( )

Run the libevent event loop.

References close(), XrdCl::Log::Debug(), DummyCallback(), XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), XrdSysMutexHelper::Lock(), pEventBase, pMutex, XrdCl::PollerMsg, and XrdSysMutexHelper::UnLock().

Referenced by RunPollerThread().

bool XrdCl::PollerLibEvent::Start ( )

virtual

Start polling.

Implements XrdCl::Poller.

References XrdCl::Log::Debug(), XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), XrdCl::PollerMsg, pPollerThread, pPollerThreadRunning, and RunPollerThread().

bool XrdCl::PollerLibEvent::Stop ( )

virtual

Stop polling.

Implements XrdCl::Poller.

References XrdCl::Log::Debug(), XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), pEventBase, XrdCl::PollerMsg, pPollerThread, and pPollerThreadRunning.

Referenced by Finalize().

Member Data Documentation

event_base* XrdCl::PollerLibEvent::pEventBase

private

Referenced by EnableReadNotification(), EnableWriteNotification(), Finalize(), Initialize(), RunEventLoop(), and Stop().

XrdSysMutex XrdCl::PollerLibEvent::pMutex

private

Referenced by AddSocket(), EnableReadNotification(), EnableWriteNotification(), IsRegistered(), RemoveSocket(), and RunEventLoop().

pthread_t XrdCl::PollerLibEvent::pPollerThread

private

Referenced by Start(), and Stop().

bool XrdCl::PollerLibEvent::pPollerThreadRunning

private

Referenced by IsRunning(), Start(), and Stop().

SocketMap XrdCl::PollerLibEvent::pSocketMap

private

Referenced by AddSocket(), EnableReadNotification(), EnableWriteNotification(), Finalize(), IsRegistered(), and RemoveSocket().

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