epicsEvent.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2011 UChicago Argonne LLC, as Operator of Argonne
*     National Laboratory.
* Copyright (c) 2002 The Regents of the University of California, as
*     Operator of Los Alamos National Laboratory.
* SPDX-License-Identifier: EPICS
* EPICS BASE is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/

#ifndef epicsEventh
#define epicsEventh

#include "libComAPI.h"

typedef struct epicsEventOSD *epicsEventId;

typedef enum {
    epicsEventOK = 0,
    epicsEventWaitTimeout,
    epicsEventError
} epicsEventStatus;

#define epicsEventWaitStatus epicsEventStatus

#define epicsEventWaitOK epicsEventOK

#define epicsEventWaitError epicsEventError

typedef enum {
    epicsEventEmpty,
    epicsEventFull
} epicsEventInitialState;

#ifdef __cplusplus

class LIBCOM_API epicsEvent {
public:
    epicsEvent ( epicsEventInitialState initial = epicsEventEmpty );
    ~epicsEvent ();
    void trigger ();
    void signal () { this->trigger(); }
    void wait ();
    bool wait ( double timeout );
    bool tryWait ();
    void show ( unsigned level ) const;

    class invalidSemaphore;         /* exception payload */
private:
    epicsEvent ( const epicsEvent & );
    epicsEvent & operator = ( const epicsEvent & );
    epicsEventId id;
};

extern "C" {
#endif /*__cplusplus */

LIBCOM_API epicsEventId epicsEventCreate(
    epicsEventInitialState initialState);

LIBCOM_API epicsEventId epicsEventMustCreate (
    epicsEventInitialState initialState);

LIBCOM_API void epicsEventDestroy(epicsEventId id);

LIBCOM_API epicsEventStatus epicsEventTrigger(
    epicsEventId id);

LIBCOM_API void epicsEventMustTrigger(epicsEventId id);

#define epicsEventSignal(ID) epicsEventMustTrigger(ID)

LIBCOM_API epicsEventStatus epicsEventWait(
    epicsEventId id);

LIBCOM_API void epicsEventMustWait(epicsEventId id);

LIBCOM_API epicsEventStatus epicsEventWaitWithTimeout(
    epicsEventId id, double timeout);

LIBCOM_API epicsEventStatus epicsEventTryWait(
    epicsEventId id);

LIBCOM_API void epicsEventShow(
    epicsEventId id, unsigned int level);

#ifdef __cplusplus
}
#endif /*__cplusplus */

#include "osdEvent.h"

#endif /* epicsEventh */