This is Unofficial EPICS BASE Doxygen Site
epicsEvent.cpp File Reference
#include <new>
#include <exception>
#include "epicsEvent.h"
#include "epicsStdio.h"
#include "cantProceed.h"
+ Include dependency graph for epicsEvent.cpp:

Go to the source code of this file.

Classes

class  epicsEvent::invalidSemaphore
 

Functions

LIBCOM_API epicsEventId epicsEventMustCreate (epicsEventInitialState initialState)
 Create an epicsEvent for use from C code. More...
 
LIBCOM_API void epicsEventMustTrigger (epicsEventId id)
 Trigger an event. More...
 
LIBCOM_API void epicsEventMustWait (epicsEventId id)
 Wait for an event (see epicsEventWait()). More...
 

Function Documentation

LIBCOM_API epicsEventId epicsEventMustCreate ( epicsEventInitialState  initialState)

Create an epicsEvent for use from C code.

This routine does not return if the object could not be created.

Parameters
initialStateStarting state, epicsEventEmpty or epicsEventFull.
Returns
An identifier for the new event.

Definition at line 106 of file epicsEvent.cpp.

108 {
109  epicsEventId id = epicsEventCreate (initialState);
110 
111  if (!id)
112  cantProceed ("epicsEventMustCreate");
113  return id;
114 }
LIBCOM_API void cantProceed(const char *msg,...)
Definition: cantProceed.c:54
LIBCOM_API epicsEventId epicsEventCreate(epicsEventInitialState initialState)
Create an epicsEvent for use from C code, or return NULL.
Definition: osdEvent.c:47
LIBCOM_API void epicsEventMustTrigger ( epicsEventId  id)

Trigger an event.

This routine does not return if the identifier is invalid.

Parameters
idThe event identifier.

Definition at line 116 of file epicsEvent.cpp.

116  {
118 
119  if (status != epicsEventOK)
120  cantProceed ("epicsEventMustTrigger");
121 }
pvd::Status status
#define epicsEventTrigger(ID)
Definition: osdEvent.h:16
epicsEventStatus
Return status from several C API routines.
Definition: epicsEvent.h:49
LIBCOM_API void cantProceed(const char *msg,...)
Definition: cantProceed.c:54
LIBCOM_API void epicsEventMustWait ( epicsEventId  id)

Wait for an event (see epicsEventWait()).

This routine does not return if the identifier is invalid.

Parameters
idThe event identifier.

Definition at line 123 of file epicsEvent.cpp.

123  {
125 
126  if (status != epicsEventOK)
127  cantProceed ("epicsEventMustWait");
128 }
pvd::Status status
#define epicsEventWait(ID)
Definition: osdEvent.h:19
epicsEventStatus
Return status from several C API routines.
Definition: epicsEvent.h:49
LIBCOM_API void cantProceed(const char *msg,...)
Definition: cantProceed.c:54