xrootd
|
#include <XrdSysIOEvents.hh>
Classes | |
struct | PipeData |
Public Types | |
enum | CreateOpts { optTOM } |
Public Member Functions | |
void | Stop () |
Poller (int cFD, int rFD) | |
virtual | ~Poller () |
Destructor. Stop() is effecively called when this object is deleted. | |
Static Public Member Functions | |
static Poller * | Create (int &eNum, const char **eTxt=0, int crOpts=0) |
Protected Member Functions | |
void | CbkTMO () |
bool | CbkXeq (Channel *cP, int events, int eNum, const char *eTxt) |
int | GetFault (Channel *cP) |
int | GetPollEnt (Channel *cP) |
int | GetRequest () |
bool | Init (Channel *cP, int &eNum, const char **eTxt, bool &isLockd) |
void | LockChannel (Channel *cP) |
int | Poll2Enum (short events) |
int | SendCmd (PipeData &cmd) |
void | SetPollEnt (Channel *cP, int ptEnt) |
bool | TmoAdd (Channel *cP, int tmoSet) |
void | TmoDel (Channel *cP) |
int | TmoGet () |
void | UnLockChannel (Channel *cP) |
virtual void | Begin (XrdSysSemaphore *syncp, int &rc, const char **eTxt)=0 |
virtual void | Exclude (Channel *cP, bool &isLocked, bool dover=1)=0 |
virtual bool | Include (Channel *cP, int &eNum, const char **eTxt, bool &isLocked)=0 |
virtual bool | Modify (Channel *cP, int &eNum, const char **eTxt, bool &isLocked)=0 |
virtual void | Shutdown ()=0 |
CPP_ATOMIC_TYPE (bool) wakePend | |
Protected Attributes | |
Channel * | attBase |
Channel * | tmoBase |
pthread_t | pollTid |
struct pollfd | pipePoll |
int | cmdFD |
int | reqFD |
PipeData | reqBuff |
char * | pipeBuff |
int | pipeBlen |
unsigned char | tmoMask |
bool | chDead |
Static Protected Attributes | |
static time_t | maxTime |
static pid_t | parentPID |
Private Member Functions | |
void | Attach (Channel *cP) |
void | Detach (Channel *cP, bool &isLocked, bool keep=true) |
void | WakeUp () |
Static Private Member Functions | |
static Poller * | newPoller (int pFD[2], int &eNum, const char **eTxt) |
Private Attributes | |
XrdSysMutex | adMutex |
XrdSysMutex | toMutex |
Friends | |
class | BootStrap |
class | Channel |
Define a poller object interface. A poller fields and dispatches event callbacks. An actual instance of a poller object is obtained by using the Create() method. You cannot simply create an instance of this object using new or in-place declaration since it is abstract. Any number of these objects may created. Each creation spawns a polling thread.
Create a specialized instance of a poller object, initialize it, and start the polling process. You must call Create() to obtain a specialized poller.
eNum | Place where errno is placed upon failure. |
eTxt | Place where a pointer to the description of the failing operation is to be set. If null, no description is returned. |
crOpts | Poller options (see static const optxxx): optTOM - Timeout resumption after a timeout event must be manually reenabled. By default, event timeouts are automatically renabled after successful callbacks. |
Enumerator | |
---|---|
optTOM |
XrdSys::IOEvents::Poller::Poller | ( | int | cFD, |
int | rFD | ||
) |
Constructor
cFD | The file descriptor to send commands to the poll thread. |
rFD | The file descriptor to recv commands in the poll thread. |
|
inlinevirtual |
Destructor. Stop() is effecively called when this object is deleted.
|
private |
|
protectedpure virtual |
Start the polling event loop. An implementation must be supplied. Begin() is called via the internal BootStrap class from a new thread.
|
protected |
|
protected |
|
protected |
|
static |
|
private |
|
protectedpure virtual |
Remove a channel to the poll set. An implementation must be supplied. The channel is locked when this method is called but must be unlocked by the method if a command is sent to the poller thread and isLocked set to false.
|
inlineprotected |
References XrdSys::IOEvents::Channel::chFault.
|
inlineprotected |
References XrdSys::IOEvents::Channel::pollEnt.
|
protected |
|
protectedpure virtual |
Add a channel to the poll set. An implementation must be supplied. The channel is locked when this method is called but must be unlocked by the method if a command is sent to the poller thread and isLocked set to false.
|
protected |
|
inlineprotected |
References XrdSys::IOEvents::Channel::chMutex, and XrdSysMutex::Lock().
|
protectedpure virtual |
Modify the event status of a channel. An implementation must be supplied. The channel is locked when this method is called but must be unlocked by the method if a command is sent to the poller thread and isLocked set to false.
|
staticprivate |
|
protected |
|
protected |
|
protected |
|
protectedpure virtual |
Shutdown the poller. An implementation must be supplied. The shutdown method must release any allocated storage and close private file descriptors. The polling thread will have already been terminated and x-thread pipe closed. Warning: the derived destructor must call Stop() and do nothing else!
void XrdSys::IOEvents::Poller::Stop | ( | ) |
Stop a poller object. Active callbacks are completed. Pending callbacks are discarded. After which the poller event thread exits. Subsequently, each associated channel is disabled and removed from the poller object. If the channel is enabled for a StopEvent, the stop callback is invoked. However, any attempt to use the channel methods that require an active poller will return an error.
Since a stopped poller cannot be restarted; the only thing left is to delete it. This also applies to all the associated channels since they no longer have an active poller.
|
protected |
|
protected |
|
protected |
|
inlineprotected |
References XrdSys::IOEvents::Channel::chMutex, and XrdSysMutex::UnLock().
|
private |
|
friend |
|
friend |
|
private |
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
private |