TaskScheduler Class Reference

#include <UsageEnvironment.hh>

Inheritance diagram for TaskScheduler:

Public Types
typedef void	BackgroundHandlerProc(void *clientData, int mask)

Public Member Functions
virtual	~TaskScheduler ()
virtual TaskToken	scheduleDelayedTask (int64_t microseconds, TaskFunc *proc, void *clientData)=0
virtual void	unscheduleDelayedTask (TaskToken &prevTask)=0
virtual void	rescheduleDelayedTask (TaskToken &task, int64_t microseconds, TaskFunc *proc, void *clientData)
virtual void	setBackgroundHandling (int socketNum, int conditionSet, BackgroundHandlerProc *handlerProc, void *clientData)=0
void	disableBackgroundHandling (int socketNum)
virtual void	moveSocketHandling (int oldSocketNum, int newSocketNum)=0
virtual void	doEventLoop (EventLoopWatchVariable *watchVariable=NULL)=0
virtual EventTriggerId	createEventTrigger (TaskFunc *eventHandlerProc)=0
virtual void	deleteEventTrigger (EventTriggerId eventTriggerId)=0
virtual void	triggerEvent (EventTriggerId eventTriggerId, void *clientData=NULL)=0
void	turnOnBackgroundReadHandling (int socketNum, BackgroundHandlerProc *handlerProc, void *clientData)
void	turnOffBackgroundReadHandling (int socketNum)
virtual void	internalError ()

Protected Member Functions
	TaskScheduler ()

Detailed Description

Definition at line 118 of file UsageEnvironment.hh.

Member Typedef Documentation

BackgroundHandlerProc

typedef void TaskScheduler::BackgroundHandlerProc(void *clientData, int mask)

Definition at line 144 of file UsageEnvironment.hh.

Constructor & Destructor Documentation

~TaskScheduler()

virtual TaskScheduler::~TaskScheduler ( )

virtual

TaskScheduler()

TaskScheduler::TaskScheduler ( )

protected

Member Function Documentation

createEventTrigger()

virtual EventTriggerId TaskScheduler::createEventTrigger ( TaskFunc * eventHandlerProc )

pure virtual

Implemented in BasicTaskScheduler0.

deleteEventTrigger()

virtual void TaskScheduler::deleteEventTrigger ( EventTriggerId eventTriggerId )

pure virtual

Implemented in BasicTaskScheduler0.

disableBackgroundHandling()

void TaskScheduler::disableBackgroundHandling ( int socketNum )

inline

Definition at line 151 of file UsageEnvironment.hh.

{ setBackgroundHandling(socketNum, 0, NULL, NULL); }

References NULL, and setBackgroundHandling().

Referenced by turnOffBackgroundReadHandling().

doEventLoop()

virtual void TaskScheduler::doEventLoop ( EventLoopWatchVariable * watchVariable = NULL )

pure virtual

Implemented in BasicTaskScheduler0.

References NULL.

internalError()

virtual void TaskScheduler::internalError ( )

virtual

moveSocketHandling()

virtual void TaskScheduler::moveSocketHandling ( int oldSocketNum, int newSocketNum )

pure virtual

Implemented in BasicTaskScheduler.

rescheduleDelayedTask()

virtual void TaskScheduler::rescheduleDelayedTask ( TaskToken & task, int64_t microseconds, TaskFunc * proc, void * clientData )

virtual

scheduleDelayedTask()

virtual TaskToken TaskScheduler::scheduleDelayedTask ( int64_t microseconds, TaskFunc * proc, void * clientData )

pure virtual

Implemented in BasicTaskScheduler0.

setBackgroundHandling()

virtual void TaskScheduler::setBackgroundHandling ( int socketNum, int conditionSet, BackgroundHandlerProc * handlerProc, void * clientData )

pure virtual

Implemented in BasicTaskScheduler.

Referenced by disableBackgroundHandling(), and turnOnBackgroundReadHandling().

triggerEvent()

virtual void TaskScheduler::triggerEvent ( EventTriggerId eventTriggerId, void * clientData = NULL )

pure virtual

Implemented in BasicTaskScheduler0.

References NULL.

turnOffBackgroundReadHandling()

void TaskScheduler::turnOffBackgroundReadHandling ( int socketNum )

inline

Definition at line 180 of file UsageEnvironment.hh.

{ disableBackgroundHandling(socketNum); }

References disableBackgroundHandling().

turnOnBackgroundReadHandling()

void TaskScheduler::turnOnBackgroundReadHandling ( int socketNum, BackgroundHandlerProc * handlerProc, void * clientData )

inline

Definition at line 177 of file UsageEnvironment.hh.

                                                                                                         {
    setBackgroundHandling(socketNum, SOCKET_READABLE, handlerProc, clientData);
  }

References setBackgroundHandling(), and SOCKET_READABLE.

unscheduleDelayedTask()

virtual void TaskScheduler::unscheduleDelayedTask ( TaskToken & prevTask )

pure virtual

Implemented in BasicTaskScheduler0.

---

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

• UsageEnvironment/include/UsageEnvironment.hh