epicsSpin.h File Reference

#include "libComAPI.h"

Include dependency graph for epicsSpin.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct epicsSpin *	epicsSpinId

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

Typedef Documentation

typedef struct epicsSpin* epicsSpinId

Definition at line 18 of file epicsSpin.h.

Function Documentation

LIBCOM_API 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;
}

LIBCOM_API void epicsSpinDestroy

(

epicsSpinId

)

Definition at line 54 of file osdSpin.c.

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

LIBCOM_API void epicsSpinLock

(

epicsSpinId

)

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");
    }
}

LIBCOM_API epicsSpinId epicsSpinMustCreate

(

void

)

Definition at line 46 of file osdSpin.c.

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

LIBCOM_API int epicsSpinTryLock

(

epicsSpinId

)

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;
}

LIBCOM_API void epicsSpinUnlock

(

epicsSpinId

)

Definition at line 81 of file osdSpin.c.

                                       {
    epicsMutexUnlock(spin->lock);
}