6-docs/doxygen/epics_ring_bytes_8h_source.html

 /*************************************************************************\

 * Copyright (c) 2002 The University of Chicago, as Operator of Argonne

 * National Laboratory.

 * Copyright (c) 2002 The Regents of the University of California, as

 * Operator of Los Alamos National Laboratory.

 * Copyright (c) 2012 ITER Organization.

 * SPDX-License-Identifier: EPICS

 * EPICS BASE is distributed subject to a Software License Agreement found

 * in file LICENSE that is included with this distribution.

 \*************************************************************************/

 #ifndef INCepicsRingBytesh

 #define INCepicsRingBytesh


 #ifdef __cplusplus

 extern "C" {

 #endif


 #include "libComAPI.h"


 typedef void *epicsRingBytesId;

 typedef void const *epicsRingBytesIdConst;


 LIBCOM_API epicsRingBytesId epicsStdCall epicsRingBytesCreate(int nbytes);

 LIBCOM_API epicsRingBytesId epicsStdCall epicsRingBytesLockedCreate(int nbytes);

 LIBCOM_API void epicsStdCall epicsRingBytesDelete(epicsRingBytesId id);

 LIBCOM_API int epicsStdCall epicsRingBytesGet(

  epicsRingBytesId id, char *value,int nbytes);

 LIBCOM_API int epicsStdCall epicsRingBytesPut(

  epicsRingBytesId id, char *value,int nbytes);

 LIBCOM_API void epicsStdCall epicsRingBytesFlush(epicsRingBytesId id);

 LIBCOM_API int epicsStdCall epicsRingBytesFreeBytes(epicsRingBytesId id);

 LIBCOM_API int epicsStdCall epicsRingBytesUsedBytes(epicsRingBytesId id);

 LIBCOM_API int epicsStdCall epicsRingBytesSize(epicsRingBytesId id);

 LIBCOM_API int epicsStdCall epicsRingBytesIsEmpty(epicsRingBytesId id);

 LIBCOM_API int epicsStdCall epicsRingBytesIsFull(epicsRingBytesId id);

 LIBCOM_API int epicsStdCall epicsRingBytesHighWaterMark(epicsRingBytesIdConst id);

 LIBCOM_API void epicsStdCall epicsRingBytesResetHighWaterMark(epicsRingBytesId id);


 #ifdef __cplusplus

 }

 #endif


 #endif /* INCepicsRingBytesh */

epicsRingBytesGet
LIBCOM_API int epicsStdCall epicsRingBytesGet(epicsRingBytesId id, char *value, int nbytes)
Read data out of the ring buffer.

value
Definition: link.h:175

epicsRingBytesFlush
LIBCOM_API void epicsStdCall epicsRingBytesFlush(epicsRingBytesId id)
Make the ring buffer empty.

epicsRingBytesIsFull
LIBCOM_API int epicsStdCall epicsRingBytesIsFull(epicsRingBytesId id)
Test if the ring buffer is currently full.

epicsRingBytesPut
LIBCOM_API int epicsStdCall epicsRingBytesPut(epicsRingBytesId id, char *value, int nbytes)
Write data into the ring buffer.

epicsRingBytesDelete
LIBCOM_API void epicsStdCall epicsRingBytesDelete(epicsRingBytesId id)
Delete the ring buffer and free any associated memory.

epicsRingBytesLockedCreate
LIBCOM_API epicsRingBytesId epicsStdCall epicsRingBytesLockedCreate(int nbytes)
Create a new ring buffer, secured by a spinlock.

epicsRingBytesUsedBytes
LIBCOM_API int epicsStdCall epicsRingBytesUsedBytes(epicsRingBytesId id)
Return the number of bytes currently stored in the ring buffer.

epicsRingBytesCreate
LIBCOM_API epicsRingBytesId epicsStdCall epicsRingBytesCreate(int nbytes)
Create a new ring buffer.

epicsRingBytesSize
LIBCOM_API int epicsStdCall epicsRingBytesSize(epicsRingBytesId id)
Return the size of the ring buffer.

epicsRingBytesFreeBytes
LIBCOM_API int epicsStdCall epicsRingBytesFreeBytes(epicsRingBytesId id)
Return the number of free bytes in the ring buffer.

epicsRingBytesResetHighWaterMark
LIBCOM_API void epicsStdCall epicsRingBytesResetHighWaterMark(epicsRingBytesId id)
Reset the Highwater mark of the ring buffer.

epicsRingBytesHighWaterMark
LIBCOM_API int epicsStdCall epicsRingBytesHighWaterMark(epicsRingBytesIdConst id)
See how full a ring buffer has been since it was last checked.

epicsRingBytesId
void * epicsRingBytesId
An identifier for a ring buffer.
Definition: epicsRingBytes.h:38

epicsRingBytesIsEmpty
LIBCOM_API int epicsStdCall epicsRingBytesIsEmpty(epicsRingBytesId id)
Test if the ring buffer is currently empty.