NAME

OTCEV_Timeout - Event object to notify that a timer has expired.

SYNOPSIS


#include <OTC/dispatch/timeout.hh>

class OTCEV_Timeout : public OTC_Event
{
  public:
    ~OTCEV_Timeout();
    inline OTCEV_Timeout(int theTimerId);
    inline int timer() const;
    void* type() const;
    inline static void* typeId();
    void dump(ostream& outs) const;
    static int start(int theAgentId, long thePeriod);
    static void cancel(int theTimerId);
    static void cancelAgent(int theAgentId);
    static OTC_Boolean active(int theTimerId);
    static long period();
    static OTC_Job* pending();
};

CLASS TYPE

Concrete

DESCRIPTION

OTCEV_Timeout is a derived version of OTC_Event specifically for notifying agents that a timer has expired.

CONSTRUCTION

inline OTCEV_Timeout(int theTimerId);

QUERY

inline int timer() const;

IDENTIFICATION

void* type() const;
inline static void* typeId();

DEBUGGING

void dump(ostream& outs) const;

SUBSCRIPTION

static int start(int theAgentId, long thePeriod);
static void cancel(int theTimerId);
static void cancelAgent(int theAgentId);
static OTC_Boolean active(int theTimerId);

SCHEDULING

static long period();
static OTC_Job* pending();

NOTES

A value of 0 will never be used as a timer ID.

SEE ALSO

OTC_EVAgent, OTC_Event

LIBRARY

OTC

AUTHOR(S)

Graham Dumpleton

COPYRIGHT

Copyright 1993 OTC LIMITED
Copyright 1994 DUMPLETON SOFTWARE CONSULTING PTY LIMITED