epicsRingBytes.h包含以下函数:
epicsRingBytesId epicsRingBytesCreate(int nbytes);
void epicsRingBytesDelete(epicsRingBytesId id);
int epicsRingBytesGet(epicsRingBytesId id, char *value,int nbytes);
int epicsRingBytesPut(epicsRingBytesId id, char *value,int nbytes);
void epicsRingBytesFlush(epicsRingBytesId id);
int epicsRingBytesFreeBytes(epicsRingBytesId id);
int epicsRingBytesUsedBytes(epicsRingBytesId id);
int epicsRingBytesSize(epicsRingBytesId id);
int epicsRingBytesIsEmpty(epicsRingBytesId id);
int epicsRingBytesIsFull(epicsRingBytesId id)
方法 | 含义 |
epicsRingBytesCreate() | 创建一个新的大小nbytes的环形缓存。返回的epicsRingBytesId被传递给其它环形缓存的方法。 |
epicsRingBytesDelete() | 删除这个环形缓存并且释放任何相关的内存。 |
epicsRingBytesGet() | 从这个环形缓存最多移动nbytes到value。返回实际移动的字节数目 |
epicsRingBytesPut() | 如果有可用的足够空间维护它们,从value移动nbytes个字节到环形缓存。返回实际移动的字节数目,如果不存在足够空间,将是0 |
epicsRingBytesFlush() | 清空这个环形缓存 |
epicsRingBytesFreeBytes() | 返回环形缓存中的空闲字节数目 |
epicsRingBytesUsedBytes() | 返回当前实际存储在环形缓存中的字节数目 |
epicsRingBytesSize() | 返回环形缓存的尺寸,即调用epcisRingBytesCreate()中指定的nbytes |
epicsRingBytesIsEmpty() | 如果环形缓存当前为空,返回(true),否则false |
epicsRingBytesIsFull() | 如果环形缓存当前为满,返回(true),否则false |
epicsRingBytes有以下属性:
- 对于有单个写入者的环形缓存,阻塞epicsRingBytesPut()调用是不必要的。
- 对于有单个读取者的环形缓存,阻塞epicsRingBytesGet()调用是不必要的。
- 仅在gets和puts都被锁定时,才应该调用epicsRingBytesFlush() 。
以上例程的使用示例的源代码:
#include <stdio.h>
#include <string.h>
#include <stdlib.h>#include "epicsRingBytes.h"char * INFO1 = "HELLO";
char * INFO2 = "WORLD";int main()
{int size1, size2;// 创建一个新的大小10字节环形缓存。epicsRingBytesId id = epicsRingBytesCreate(10);if (id == NULL){printf("Call epicsRingBytesCreate failed\n");exit(1);}// 获取这个环形缓存的大小,未用空间,已用空间int size = epicsRingBytesSize(id);int unused_size = epicsRingBytesFreeBytes(id);int used_size = epicsRingBytesUsedBytes(id);printf("total size: %d, used size: %d, unused size: %d\n", size, used_size, unused_size);// 将字符串中字符放入这个环形缓存printf("Put String : %s and %s into the ring buffer\n", INFO1, INFO2);size1 = epicsRingBytesPut(id, INFO1, strlen(INFO1));size2 = epicsRingBytesPut(id, INFO2, strlen(INFO2));unused_size = epicsRingBytesFreeBytes(id);used_size = epicsRingBytesUsedBytes(id);printf("completed putting %d bytes to the ring buffer\n", size1+size2);printf("total size: %d, used size: %d, unused size: %d\n", size, used_size, unused_size);// 从环形缓存中取字符char * str = (char *)calloc(sizeof(char), 10);size1 = epicsRingBytesGet(id, str, size1);unused_size = epicsRingBytesFreeBytes(id);used_size = epicsRingBytesUsedBytes(id);printf("Completed getting %d bytes from the ring buffer\n", size1);printf("%s\n", str);printf("total size: %d, used size: %d, unused size: %d\n", size, used_size, unused_size);memset(str, 0, 10);size2 = epicsRingBytesGet(id, str, size2);unused_size = epicsRingBytesFreeBytes(id);used_size = epicsRingBytesUsedBytes(id);printf("Completed getting %d bytes from the ring buffer\n", size2);printf("%s\n", str);printf("total size: %d, used size: %d, unused size: %d\n", size, used_size, unused_size);free(str);epicsRingBytesDelete(id);return 0;
}
以上程序测试结果:
root@orangepi4-lts:/home/orangepi/host_program/host/hostApp# O.linux-aarch64/ringbuffer
total size: 10, used size: 0, unused size: 10
Put String : HELLO and WORLD into the ring buffer
completed putting 10 bytes to the ring buffer
total size: 10, used size: 10, unused size: 0
Completed getting 5 bytes from the ring buffer
HELLO
total size: 10, used size: 5, unused size: 5
Completed getting 5 bytes from the ring buffer
WORLD
total size: 10, used size: 0, unused size: 10