Events.h

Go to the documentation of this file.

//===-- temu-c/Events.h - Event Queue API -----------------------*- C++ -*-===//
//
// T-EMU: The Terma Emulator
// (c) Terma 2015
// Authors: Mattias Holm <maho (at) terma.com>
//
//===----------------------------------------------------------------------===//

#ifndef TEMU_EVENTS_H
#define TEMU_EVENTS_H

#include <stdint.h>
#include "temu-c/Support/Objsys.h"

#ifdef __cplusplus
extern "C" {
#endif

#define TEMU_EVENT_NS   (1U << 0)
#define TEMU_EVENT_SYNC (1U << 8)

typedef void (*temu_TimerCb)(void *Sender, void *Data);

void* temu_allocateEventQueue(void);
void temu_disposeEventQueue(void *Queue);

int64_t temu_triggerFirstTimer(void *Queue, uint32_t Flags);
int64_t temu_triggerCurrentTimers(void *Queue, int64_t Srt, uint32_t Flags);

int64_t temu_nextTimer(void *Queue, uint32_t Flags);

void temu_postEvent(void *Queue, temu_TimerCb callback,
                    void *Sender, void *Data, uint64_t Time, uint32_t Flags);

void temu_stackEvent(void *Queue, temu_TimerCb callback,
                     void *Sender, void *Data, uint32_t Flags);

/*
  \brief Get the next time stamp for the given callback function.
 */
int64_t temu_eventTime(void *Queue, temu_TimerCb callback,
                       void *Sender);

void temu_descheduleEvent(void *Queue,
                          temu_TimerCb callback,
                          void *Sender);

// Posting callback from other threads
typedef void (*temu_ThreadSafeCb)(void*);
void temu_postCallbackInQueue(void *Queue, temu_ThreadSafeCb Cb, void *Arg);

typedef struct {
  void (*stackPostEvent)(void *Obj, temu_TimerCb Ev, void *Sender, void *Data,
                         uint32_t Flags);

  void (*postDeltaEvent)(void *Obj, temu_TimerCb Ev, void *Sender, void *Data,
                         int64_t Cycles, uint32_t Flags);

  void (*postAbsoluteEvent)(void *Obj, temu_TimerCb Ev, void *Sender, void *Data,
                            int64_t Cycles, uint32_t Flags);
  int64_t (*getEventDeltaTime)(void *Obj, temu_TimerCb Ev,
                               void *Sender);
  int64_t (*getEventAbsoluteTime)(void *Obj, temu_TimerCb Ev,
                                  void *Sender);
  void (*descheduleEvent)(void *Obj, temu_TimerCb Ev, void *Sender,
                          uint32_t Flags);
  void (*registerEvent)(void *Obj, const char *EvName,
                        void (*Ev)(void *, void *), uint32_t Flags);

  void (*postCallback)(void *Obj, temu_ThreadSafeCb Cb, void *Arg);

} temu_EventIface;

TEMU_IFACE_REFERENCE_TYPE(temu_Event);

// Serialisation support
void temu_registerEvent(void *Queue, const char *Name,
                        temu_TimerCb Callback,
                        uint32_t Flags);
void temu_serialiseEvents(void *Obj, void *Ctxt);
void temu_deserialiseEvents(void *Obj, void *Ctxt);


#ifdef __cplusplus
}
#endif

#endif /*  ! TEMU_EVENTS_H */