osdSpin.c File Reference

#include <stdlib.h>
#include "cantProceed.h"
#include "errlog.h"
#include "epicsMutex.h"
#include "epicsSpin.h"

Include dependency graph for osdSpin.c:

Go to the source code of this file.

Classes
struct	epicsSpin

Typedefs
typedef struct epicsSpin	epicsSpin

Functions
epicsSpinId	epicsSpinCreate (void)
epicsSpinId	epicsSpinMustCreate (void)
void	epicsSpinDestroy (epicsSpinId spin)
void	epicsSpinLock (epicsSpinId spin)
int	epicsSpinTryLock (epicsSpinId spin)
void	epicsSpinUnlock (epicsSpinId spin)

Typedef Documentation

typedef struct epicsSpin epicsSpin

Function Documentation

epicsSpinId epicsSpinCreate

(

void

)

Definition at line 28 of file osdSpin.c.

                                  {
    epicsSpin *spin;

    spin = calloc(1, sizeof(*spin));
    if (!spin)
        goto fail;

    spin->lock = epicsMutexCreate();
    if (!spin->lock)
        goto fail;

    return spin;

fail:
    free(spin);
    return NULL;
}

void epicsSpinDestroy

(

epicsSpinId

spin

)

Definition at line 54 of file osdSpin.c.

                                        {
    epicsMutexDestroy(spin->lock);
    free(spin);
}

void epicsSpinLock

(

epicsSpinId

spin

)

Definition at line 59 of file osdSpin.c.

                                     {
    epicsMutexLockStatus status;

    status = epicsMutexLock(spin->lock);
    if (status != epicsMutexLockOK) {
        errlogPrintf("epicsSpinLock(%p): epicsMutexLock returned %s\n", spin,
                     status == epicsMutexLockTimeout ?
                         "epicsMutexLockTimeout" : "epicsMutexLockError");
    }
}

epicsSpinId epicsSpinMustCreate

(

void

)

Definition at line 46 of file osdSpin.c.

{
    epicsSpinId ret = epicsSpinCreate();
    if(!ret)
        cantProceed("epicsSpinMustCreate: epicsSpinCreate failed.");
    return ret;
}

int epicsSpinTryLock

(

epicsSpinId

spin

)

Definition at line 70 of file osdSpin.c.

                                       {
    epicsMutexLockStatus status;

    status = epicsMutexTryLock(spin->lock);
    if (status == epicsMutexLockOK) return 0;
    if (status == epicsMutexLockTimeout) return 1;

    errlogPrintf("epicsSpinTryLock(%p): epicsMutexTryLock returned epicsMutexLockError\n", spin);
    return 2;
}

void epicsSpinUnlock

(

epicsSpinId

spin

)

Definition at line 81 of file osdSpin.c.

                                       {
    epicsMutexUnlock(spin->lock);
}