GLOW API version 1.0 reference

Back to Table of contents

typedef GlowIdleReceiver

General information

type: abstract
synonym: TReceiver<const GlowIdleMessage&>
module: glow

GlowIdleReceiver is the base class of receivers of idle events. Subclasses should override the OnMessage() method to handle an idle event.

Some GLOW programs may make use of idle events. These include programs that perform processing in the background.

Types

Types

typedef const GlowIdleMessage& MessageType

A synonym for the type of message.

Methods

Destructor

~GlowIdleReceiver(void)

Automatically informs GLOW that this receiver is going away.

Information on senders
A receiver can provide rudimentary information on which senders are bound to it.

unsigned int NumSenders(void)

Returns the number of senders bound to this receiver. Should be 1 if the receiver is registered with GLOW, or 0 if the receiver is not.

unsigned int NumTrackers(void)

Returns the number of trackers bound to this receiver.

Overrideable methods

Receiving messages

virtual void OnMessage(const GlowIdleMessage& message) = 0

This is a pure virtual method that must be overridden by a subclass. It is called whenever the receiver receives an idle event notification.

Back to Table of contents