Notifications.h

Go to the documentation of this file.

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

#ifndef TEMU_NOTIFICATIONS_H
#define TEMU_NOTIFICATIONS_H

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

// The following interfaces are for non-timed events (or
// notifications). Notification 0 is reserved as a special
// no-notification handler connected id. Notifications have a name and
// are associated with an object. The subscriber can request a
// notification with a null object (i.e. will accept all identical
// notifications, or a given object, which means the notification
// handler will be called only for some objects.  There is currently
// no way to depublish a notification, but the standard approach is to
// set the notification id to 0.
#ifdef __cplusplus
extern "C" {
#endif

typedef void (*temu_NotificationHandler)(void *Arg, void *Source, void *NotInfo);

TEMU_API int64_t temu_publishNotification(const char *NotName, void *Obj);

TEMU_API int temu_subscribeNotification(const char *NotName, void *Source, void *Arg,
                               temu_NotificationHandler NotFunc);

TEMU_API int temu_unsubscribeNotification(const char *NotName, void *Source,
                                 temu_NotificationHandler NotFunc);

TEMU_API int temu_unsubscribeNotificationArg(const char *NotName, void *Source,
                                             temu_NotificationHandler NotFunc,
                                             void *Arg);


TEMU_API void temu_notify(int64_t Id, void *NotInfo);

static inline void
temu_notifyFast(int64_t *Id, void *NotInfo)
{
  if (*Id) {
    temu_notify(*Id, NotInfo);
  }
}

#ifdef __cplusplus
}
#endif

#endif /*  ! TEMU_EVENTS_H */