libsidplayfp  0.3.5
Public Member Functions | Friends | List of all members
Event Class Reference

#include <event.h>

Inheritance diagram for Event:
EventCallback< This > HardSID MOS656X SID6526 Timer XSID c64vic TimerA TimerB c64xsid

Public Member Functions

 Event (const char *const name)
virtual void event (void)=0
bool pending () const
SID_DEPRECATED void cancel ()
SID_DEPRECATED void schedule (EventContext &context, event_clock_t cycles, event_phase_t phase)

Friends

class EventScheduler

Detailed Description

Event scheduler (based on alarm from Vice). Created in 2001 by Simon A. White.

Optimized EventScheduler and corresponding Event class by Antti S. Lankila in 2009.

Author
Antti Lankila

Constructor & Destructor Documentation

Event::Event ( const char *const  name)
inline

Events are used for delayed execution. Name is not used by code, but is useful for debugging.

Parameters
nameDescriptive string of the event.

Member Function Documentation

void Event::cancel ( )
inline

Cancel the specified event.

Deprecated:
use EventContext::cancel
virtual void Event::event ( void  )
pure virtual

Event code to be executed. Events are allowed to safely reschedule themselves with the EventScheduler during invocations.

bool Event::pending ( ) const
inline

Is Event scheduled?

void Event::schedule ( EventContext context,
event_clock_t  cycles,
event_phase_t  phase 
)
inline

Add event to pending queue.

Deprecated:
use EventContext::schedule

The documentation for this class was generated from the following file: