SFBDispatcher

Wrapper Class for the IDispatcher interface.

#include <SFBDispatcher.h.hpp>

class SFBDispatcher : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBDispatcher)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	X	O

Reference

BREW API IDispatcher

Member

Public Functions
`Void`	AtTime( `SFXCallbackPtr` callback , `UInt32` when ) AtTime() schedules a callback to be called at the specified time.
`Void`	Call( `SFXCallbackPtr` callback ) Call() schedules a callback to be called immediately, _before_ any currently ready callbacks.
`Void`	Dispatch( `Void` ) Dispatch() calls all pending callbacks.
`UInt32`	GetTime( `Void` ) GetTime() returns a number of millisconds from some fixed point in time.
static `SFBDispatcherSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBDispatcher instance.
static `SFBDispatcherSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBDispatcher instance.
`Void`	Resume( `SFXCallbackPtr` callback ) Resume() schedules a callback on the ready queue. This will cause it to be called immediately _after_ currently ready callbacks are processed.
`Void`	Timer( `SFXCallbackPtr` callback , `SInt32` delay ) Timer() schedules a callback to be called after the specified time delay.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBDispatcher::AtTime

AtTime() schedules a callback to be called at the specified time.

[ public ]
Void AtTime(
    SFXCallbackPtr callback   // Pointer to a SFXCallback object
    UInt32 when               // time at which callback becomes ready for dispatch 
);

Reference

BREW API IDispatcher_AtTime

SFBDispatcher::Call

Call() schedules a callback to be called immediately, _before_ any currently ready callbacks.

[ public ]
Void Call(
    SFXCallbackPtr callback   // Pointer to a SFCCallback object
);

Reference

BREW API IDispatcher_Call

SFBDispatcher::Dispatch

Dispatch() calls all pending callbacks.

[ public ]
Void Dispatch(Void);

Reference

BREW API IDispatcher_Dispatch

SFBDispatcher::GetTime

GetTime() returns a number of millisconds from some fixed point in time.

[ public ]
UInt32 GetTime(Void);

Reference

BREW API IDispatcher_GetTime

SFBDispatcher::NewInstance

Create a new SFBDispatcher instance.

[ public, static ]
SFBDispatcherSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBDispatcherSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBDispatcher::Resume

Resume() schedules a callback on the ready queue. This will cause it to be called immediately _after_ currently ready callbacks are processed.

[ public ]
Void Resume(
    SFXCallbackPtr callback   // Pointer to a SFXCallback object
);

Reference

BREW API IDispatcher_Resume

SFBDispatcher::Timer

Timer() schedules a callback to be called after the specified time delay.

[ public ]
Void Timer(
    SFXCallbackPtr callback   // Pointer to a SFXCallback object
    SInt32 delay              // time delay in milliseconds
);

Reference

BREW API IDispatcher_Timer