osdEvent.c File Reference

#include <vxWorks.h>
#include <semLib.h>
#include <time.h>
#include <objLib.h>
#include <sysLib.h>
#include <limits.h>
#include "epicsEvent.h"

Include dependency graph for osdEvent.c:

Go to the source code of this file.

Functions
int	sysClkRateGet (void)
epicsEventId	epicsEventCreate (epicsEventInitialState initialState)
	Create an epicsEvent for use from C code, or return NULL. More...
void	epicsEventDestroy (epicsEventId id)
	Destroy an epicsEvent and any resources it holds. More...
epicsEventStatus	epicsEventWaitWithTimeout (epicsEventId id, double timeOut)
	Wait an the event or until the specified timeout period is over. More...
epicsEventStatus	epicsEventTryWait (epicsEventId id)
	Similar to wait() except that if the event is currenly empty the call will return immediately with status epicsEventWaitTimeout. More...
void	epicsEventShow (epicsEventId id, unsigned int level)
	Display information about the semaphore. More...

Function Documentation

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 25 of file osdEvent.c.

{
    return (epicsEventId) semBCreate(SEM_Q_FIFO,
        (initialState == epicsEventEmpty) ? SEM_EMPTY : SEM_FULL);
}

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 31 of file osdEvent.c.

{
    semDelete((SEM_ID)id);
}

void epicsEventShow	(	epicsEventId	id,
		unsigned int	level
	)

Display information about the semaphore.

Note

The information displayed is architecture dependant.

Parameters

id	The event identifier.
level	An unsigned int for the level of information to be displayed.

Definition at line 71 of file osdEvent.c.

{
    semShow((SEM_ID)id,level);
}

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 60 of file osdEvent.c.

{
    int status = semTake((SEM_ID)id, NO_WAIT);

    if (status == OK)
        return epicsEventOK;
    if (errno == S_objLib_OBJ_UNAVAILABLE)
        return epicsEventWaitTimeout;
    return epicsEventError;
}

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 36 of file osdEvent.c.

{
    int rate = sysClkRateGet();
    int status;
    int ticks;

    if (timeOut <= 0.0) {
        ticks = 0;
    } else if (timeOut >= (double) INT_MAX / rate) {
        ticks = WAIT_FOREVER;
    } else {
        ticks = timeOut * rate;
        if (ticks <= 0)
            ticks = 1;
    }
    status = semTake((SEM_ID)id, ticks);
    if (status == OK)
        return epicsEventOK;
    if (errno == S_objLib_OBJ_TIMEOUT ||
        (errno == S_objLib_OBJ_UNAVAILABLE && ticks == 0))
        return epicsEventWaitTimeout;
    return epicsEventError;
}

int sysClkRateGet

(

void

)