osdEvent.c File Reference

#include <limits.h>
#include <windows.h>
#include "libComAPI.h"
#include "epicsEvent.h"

Include dependency graph for osdEvent.c:

Go to the source code of this file.

Classes
struct	epicsEventOSD

Macros
#define	VC_EXTRALEAN
#define	STRICT

Typedefs
typedef struct epicsEventOSD	epicsEventOSD

Functions
LIBCOM_API epicsEventId	epicsEventCreate (epicsEventInitialState initialState)
	Create an epicsEvent for use from C code, or return NULL. More...
LIBCOM_API void	epicsEventDestroy (epicsEventId pSem)
	Destroy an epicsEvent and any resources it holds. More...
LIBCOM_API epicsEventStatus	epicsEventTrigger (epicsEventId pSem)
	Trigger an event i.e. ensures the next or current call to wait completes. More...
LIBCOM_API epicsEventStatus	epicsEventWait (epicsEventId pSem)
	Wait for an event. More...
LIBCOM_API epicsEventStatus	epicsEventWaitWithTimeout (epicsEventId pSem, double timeOut)
	Wait an the event or until the specified timeout period is over. More...
LIBCOM_API epicsEventStatus	epicsEventTryWait (epicsEventId pSem)
	Similar to wait() except that if the event is currenly empty the call will return immediately with status epicsEventWaitTimeout. More...
LIBCOM_API void	epicsEventShow (epicsEventId id, unsigned level)

Macro Definition Documentation

#define STRICT

Definition at line 22 of file osdEvent.c.

#define VC_EXTRALEAN

Definition at line 21 of file osdEvent.c.

Typedef Documentation

typedef struct epicsEventOSD epicsEventOSD

Function Documentation

LIBCOM_API epicsEventId epicsEventCreate

(

epicsEventInitialState

initialState

)

Create an epicsEvent for use from C code, or return NULL.

Parameters

initialState

Starting state, epicsEventEmpty or epicsEventFull.

Returns

An identifier for the new event, or NULL if one not be created.

Definition at line 35 of file osdEvent.c.

{
    epicsEventOSD *pSem;

    pSem = malloc ( sizeof ( *pSem ) );
    if ( pSem ) {
        pSem->handle =  CreateEvent ( NULL, FALSE, initialState?TRUE:FALSE, NULL );
        if ( pSem->handle == 0 ) {
            free ( pSem );
            pSem = 0;
        }
    }

    return pSem;
}

LIBCOM_API void epicsEventDestroy

(

epicsEventId

id

)

Destroy an epicsEvent and any resources it holds.

No calls to any epicsEventWait routines can be active when this call is made.

Parameters

id	The event identifier.

Definition at line 55 of file osdEvent.c.

{
    CloseHandle ( pSem->handle );
    free ( pSem );
}

LIBCOM_API void epicsEventShow	(	epicsEventId	id,
		unsigned	level
	)

Definition at line 142 of file osdEvent.c.

{
}

LIBCOM_API epicsEventStatus epicsEventTrigger

(

epicsEventId

id

)

Trigger an event i.e. ensures the next or current call to wait completes.

Note

This method may be called from a VxWorks or RTEMS interrupt handler.

Parameters

id	The event identifier.

Returns

Status indicator.

Definition at line 64 of file osdEvent.c.

{
    BOOL status;
    status = SetEvent ( pSem->handle );
    return status ? epicsEventOK : epicsEventError;
}

LIBCOM_API epicsEventStatus epicsEventTryWait

(

epicsEventId

id

)

Similar to wait() except that if the event is currenly empty the call will return immediately with status epicsEventWaitTimeout.

Parameters

id	The event identifier.

Returns

Status indicator, epicsEventWaitTimeout when the event is empty.

Definition at line 123 of file osdEvent.c.

{
    DWORD status;

    status = WaitForSingleObject ( pSem->handle, 0 );
    if ( status == WAIT_OBJECT_0 ) {
        return epicsEventOK;
    }
    else if ( status == WAIT_TIMEOUT ) {
        return epicsEventWaitTimeout;
    }
    else {
        return epicsEventError;
    }
}

LIBCOM_API epicsEventStatus epicsEventWait

(

epicsEventId

id

)

Wait for an event.

Note

Blocks until full.

Parameters

id	The event identifier.

Returns

Status indicator.

Definition at line 74 of file osdEvent.c.

{
    DWORD status;
    status = WaitForSingleObject (pSem->handle, INFINITE);
    if ( status == WAIT_OBJECT_0 ) {
        return epicsEventOK;
    }
    else {
        return epicsEventError;
    }
}

LIBCOM_API epicsEventStatus epicsEventWaitWithTimeout	(	epicsEventId	id,
		double	timeOut
	)

Wait an the event or until the specified timeout period is over.

Note

Blocks until full or timeout.

Parameters

id	The event identifier.
timeOut	The timeout delay in seconds.

Returns

Status indicator.

Definition at line 89 of file osdEvent.c.

{
    static const unsigned mSecPerSec = 1000;
    DWORD status;
    DWORD tmo;

    if ( timeOut <= 0.0 ) {
        tmo = 0u;
    }
    else if ( timeOut >= INFINITE / mSecPerSec ) {
        tmo = INFINITE - 1;
    }
    else {
        tmo = ( DWORD ) ( ( timeOut * mSecPerSec ) + 0.5 );
        if ( tmo == 0 ) {
            tmo = 1;
        }
    }
    status = WaitForSingleObject ( pSem->handle, tmo );
    if ( status == WAIT_OBJECT_0 ) {
        return epicsEventOK;
    }
    else if ( status == WAIT_TIMEOUT ) {
        return epicsEventWaitTimeout;
    }
    else {
        return epicsEventError;
    }
}