NAME

OTCEV_Action - Event object to notify that it is time to perform some action.

SYNOPSIS


#include <OTC/dispatch/action.hh>

class OTCEV_Action : public OTC_Event
{
  public:
    ~OTCEV_Action();
    inline OTCEV_Action(int theActionId);
    inline int action() const;
    void* type() const;
    inline static void* typeId();
    void dump(ostream& outs) const;
    static int schedule(int theAgentId);
    static void cancel(int theActionId);
    static void cancelAgent(int theAgentId);
    static OTC_Boolean active(int theActionId);
};

CLASS TYPE

Concrete

DESCRIPTION

OTCEV_Action is a derived version of OTC_Event for notifying agents that it should now perform whatever action that it has been waiting to perform. A request to receive this event is registered as an idle job, and will only be delivered when the dispatcher has nothing else to do.

CONSTRUCTION

inline OTCEV_Action(int theActionId);

QUERY

inline int action() const;

IDENTIFICATION

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

DEBUGGING

void dump(ostream& outs) const;

SUBSCRIPTION

static int schedule(int theAgentId);
static void cancel(int theActionId);
static void cancelAgent(int theAgentId);
static OTC_Boolean active(int theActionId);

NOTES

A value of 0 will never be used as an action ID.

SEE ALSO

OTC_EVAgent, OTC_Event

LIBRARY

OTC

AUTHOR(S)

Graham Dumpleton

COPYRIGHT

Copyright 1994 DUMPLETON SOFTWARE CONSULTING PTY LIMITED