code::SQLEventHandler Class Reference

Inheritance diagram for code::SQLEventHandler:

code::EventHandler List of all members.

Static Public Member Functions

static void attach (SQLIndex *)
static void detach (SQLIndex *)
static void introduceSelf ()
static void handle_events ()
 It is the user's responsibility to call this function once in a while.
static void setIdleTime (size_t milliseconds)
 Change the idle time that handle_events will wait, so that the CPU is not caught in a do-nothing mode.
static void pauseNotification ()
 When calling a non-reentrant function (outside of a callback), it might be useful to turn off the signal, so that you are not interrupted.
static void resumeNotification ()
 Resume notification after it has been paused.

Protected Member Functions

virtual void addCallbacks ()
 This should effectively be a static function that adds to EventHandler's allCallbacks.

Static Protected Member Functions

static void introduce (SmartPtr< EventHandler > subclass)
static void setMaxCallbacks ()

Static Protected Attributes

static std::map< SQLIndex *,
CallbackInfo > 
callbacks
static std::vector< CallbackInfo > allCallbacks
 The set of all the event callbacks.

Classes

class  SQLEventCallback

Member Function Documentation

virtual void code::SQLEventHandler::addCallbacks (  )  [protected, virtual]

This should effectively be a static function that adds to EventHandler's allCallbacks.

Reimplemented from code::EventHandler.

static void code::SQLEventHandler::attach ( SQLIndex  )  [static]

static void code::SQLEventHandler::detach ( SQLIndex  )  [static]

static void code::EventHandler::handle_events (  )  [static, inherited]

It is the user's responsibility to call this function once in a while.

When the function is called, the callbacks associated with all the events that have happened so far are invoked.

If there are no callbacks to process, handle_events will sleep a while before returning, so as to avoid over-loading the CPU waiting for messages.

You can set this sleep interval using setIdleTime()

static void code::EventHandler::introduce ( SmartPtr< EventHandler subclass  )  [static, protected, inherited]

static void code::SQLEventHandler::introduceSelf (  )  [static]

static void code::EventHandler::pauseNotification (  )  [static, inherited]

When calling a non-reentrant function (outside of a callback), it might be useful to turn off the signal, so that you are not interrupted.

In this case, signals will be queued up and delivered on a resume call.

Pauses may not be nested. If a re-entrant form of your function exists, you might want to use it instead of using the pause facility.

Note: This function is not needed in the threaded OPUP environment. Re-entrant functions are safe in that context.

static void code::EventHandler::resumeNotification (  )  [static, inherited]

Resume notification after it has been paused.

static void code::EventHandler::setIdleTime ( size_t  milliseconds  )  [static, inherited]

Change the idle time that handle_events will wait, so that the CPU is not caught in a do-nothing mode.

The default is 1 second.

You can set it to zero, if needed.

static void code::EventHandler::setMaxCallbacks (  )  [static, protected, inherited]


Member Data Documentation

std::vector< CallbackInfo > code::EventHandler::allCallbacks [static, protected, inherited]

The set of all the event callbacks.

std::map<SQLIndex*, CallbackInfo> code::SQLEventHandler::callbacks [static, protected]


Generated on Fri May 4 13:40:12 2012 for WDSS-IIw2 by  doxygen 1.4.7