Wt  3.3.0
Public Member Functions | Static Public Member Functions
Wt::WTimer Class Reference

A utility class which provides timer signals and single-shot timers. More...

#include <Wt/WTimer>

Inheritance diagram for Wt::WTimer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 WTimer (WObject *parent=0)
 Construct a new timer with the given parent.
 ~WTimer ()
 Destuctor.
int interval () const
 Returns the interval (msec).
void setInterval (int msec)
 Sets the interval (msec).
bool isActive () const
 Returns if the timer is running.
bool isSingleShot () const
 Is this timer set to fire only once.
void setSingleShot (bool singleShot)
 Configures this timer to fire only once.
void start ()
 Starts the timer.
void stop ()
 Stops the timer.
EventSignal< WMouseEvent > & timeout ()
 Signal emitted when the timer timeouts.

Static Public Member Functions

template<class T , class V >
static void singleShot (int msec, T *receiver, void(V::*method)())
 This static function calls a slot after a given time interval.
template<class F >
static void singleShot (int msec, const F &f)
 This static function calls a function after a given time interval.

Detailed Description

A utility class which provides timer signals and single-shot timers.

To use a timer, create a WTimer instance, set the timer interval using setInterval() and connect a slot to the timeout signal. Then, start the timer using start(). An active timer may be cancelled at any time using stop().

By default, a timer will continue to generate events until you stop() it. To create a timer that will fire only once, use setSingleShot(). There is also a convience static method singleShot().

When connecting stateless slot implementations to the timeout signal, these stateless slot implementations will be used as for any other signal (when Ajax is available).

In clients without (enabled) JavaScript support, the minimum resolution of the timer is one second (1000 milli-seconds), and it is probably wise to use timers sparingly.

A WTimer is only usable inside of a Wt event loop. If you want to create a timer outside the Wt event loop, take a look at asio deadline_timer.

Timers are one way to provide updates of a web page without the user generating an event. Alternatively you may consider server-initiated updates, see WApplication::enableUpdates().

Usage example:

 // setup a timer which calls MyClass::timeout() every 2 seconds, until timer->stop() is called.
 Wt::WTimer *timer = new Wt::WTimer();
 timer->setInterval(2000);
 timer->timeout().connect(this, &MyClass::timeout);
 timer->start();

Member Function Documentation

void Wt::WTimer::setSingleShot ( bool  singleShot)

Configures this timer to fire only once.

A Timer is by default not single shot, and will fire continuously, until it is stopped.

See also:
singleShot()
template<class T , class V >
void Wt::WTimer::singleShot ( int  msec,
T *  receiver,
void(V::*)()  method 
) [static]

This static function calls a slot after a given time interval.

For example, the following code will call this->doSome() after 2 seconds:

   WTimer::singleShot(2000, this, &MyClass::doSome);
template<class F >
void Wt::WTimer::singleShot ( int  msec,
const F &  f 
) [static]

This static function calls a function after a given time interval.

This variant of the overloaded singleShot() method supports a template function object (which supports operator ()).

void Wt::WTimer::start ( )

Starts the timer.

The timer will be isActive(), until either the interval has elapsed, after which the timeout signal is activated, or until stop() is called.

void Wt::WTimer::stop ( )

Stops the timer.

You may stop the timer during its timeout(), or cancel a running timer at any other time.

See also:
start()
EventSignal< WMouseEvent > & Wt::WTimer::timeout ( )

Signal emitted when the timer timeouts.

The WMouseEvent does not provide any meaningful information but is an implementation artefact.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator

Generated on Mon Apr 8 2013 for the C++ Web Toolkit (Wt) by doxygen 1.7.5.1