Nut/OS  4.10.3
API Reference
perci.h File Reference
#include <cfg/perci.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
Include dependency graph for perci.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _PERCI_RECORD
struct  _PERCI_WRITER
struct  _PERCI_READER

Defines

#define PERCI_MAX_RECORDS   256
#define PERCI_RECSIZE   256
#define PERCI_DATASIZE   (PERCI_RECSIZE - sizeof(perci_reclen_t))

Typedefs

typedef uint8_t perci_recnum_t
typedef uint_fast8_t perci_fast_recnum_t
typedef uint8_t perci_reclen_t
typedef uint_fast8_t perci_fast_reclen_t
typedef struct _PERCI_RECORD PERCI_RECORD
typedef struct _PERCI_WRITER PERCI_WRITER
typedef struct _PERCI_READER PERCI_READER

Functions

int PerCiInit (char *path, int recs)
 Initialize a ring buffer file.
PERCI_WRITERPerCiOpen (char *path)
 Open a ring buffer file.
void PerCiClose (PERCI_WRITER *writer)
 Close a ring buffer file.
void PerCiFlush (PERCI_WRITER *writer)
 Flush the current write buffer.
int PerCiWrite (PERCI_WRITER *writer, CONST char *data, int len)
 Write to a ring buffer file.
int PerCiWriteFormat (PERCI_WRITER *writer, CONST char *fmt,...)
 Write formatted line to a ring buffer file.
int PerCiWriteVarList (PERCI_WRITER *writer, CONST char *fmt, va_list ap)
 Write formatted line to a ring buffer file.
PERCI_READERPerCiAttachReader (PERCI_WRITER *writer)
 Start reading from a ring buffer file.
void PerCiDetachReader (PERCI_READER *reader)
 Stop reading from a ring buffer file.
int PerCiRead (PERCI_READER *reader, char *data, int len)
 Read data from a ring buffer file.
int PerCiReadLine (PERCI_READER *reader, char *line, int len)
 Read a text line from a ring buffer file.
void PerCiDump (FILE *stream, char *path)
 Dump ring buffer file to given stream.