Main Page   Class Hierarchy   Compound List   File List   Compound Members  

SmartSockets::TimerEvent Class Reference

#include <tevent.h>

Inheritance diagram for SmartSockets::TimerEvent::

SmartSockets::TipcEvent List of all members.

Public Methods

real8 getTimerInterval () throw (TipcException)
void setTimerInterval (real8 interval) throw (TipcException)

Friends

class T_IPCX_API TipcDispatcher
class T_IPCX_API TipcDispatcherTraverser

Detailed Description

Class that represents a timer event that is invoked every interval seconds on the specified TipcDispatcher. If the timer is to be invoked only once then destroy the event in the event_func.

This class contains the TimerEventHandler object and method that is called by the TipcDispatcher when this event is triggered.

Warning:
Do not delete this object using the delete operator; call either the TipcEvent::destroy() method, or the TipcDispatcher::destroyEvent() method.


Member Function Documentation

real8 SmartSockets::TimerEvent::getTimerInterval   throw (TipcException) [inline]
 

Gets the current timer interval (in seconds) for this event.

void SmartSockets::TimerEvent::setTimerInterval real8    interval throw (TipcException) [inline]
 

Sets the timer interval (in seconds) for this event. Subsequent events of this type will start occurring interval number of seconds from this call.


The documentation for this class was generated from the following file:
Generated on Fri Jul 14 15:05:55 2006 by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001