Belle II Software light-2406-ragdoll
RingBufInfo Struct Reference

Internal metadata structure for RingBuffer. More...

#include <RingBuffer.h>

Public Attributes

int size
 ring buffer size (integers), minus this header.
 
int remain
 Unsure, always equal to size.
 
int wptr
 Pointer for writing entries.
 
int prevwptr
 Previous state of wptr (for error recovery).
 
int rptr
 Pointer for reading entries.
 
int nbuf
 Number of entries in ring buffer.
 
int semid
 Semaphore ID.
 
int nattached
 Number of RingBuffer instances currently attached to this buffer.
 
int nbusy
 Number of attached reading processes currently processing events.
 
int __readbuf
 Unused.
 
int errtype
 Error state? 0: Normal, 1: buffer full and wptr>rptr, others are complicated.
 
int numAttachedTx
 number of attached sending processes.
 
int ninsq
 Count insq() calls for this buffer.
 
int nremq
 Count remq() calls for this buffer.
 

Detailed Description

Internal metadata structure for RingBuffer.

Placed on top of the shared memory.

Definition at line 21 of file RingBuffer.h.

Member Data Documentation

◆ __readbuf

int __readbuf

Unused.

Definition at line 31 of file RingBuffer.h.

◆ errtype

int errtype

Error state? 0: Normal, 1: buffer full and wptr>rptr, others are complicated.

Definition at line 32 of file RingBuffer.h.

◆ nattached

int nattached

Number of RingBuffer instances currently attached to this buffer.

Definition at line 29 of file RingBuffer.h.

◆ nbuf

int nbuf

Number of entries in ring buffer.

Definition at line 27 of file RingBuffer.h.

◆ nbusy

int nbusy

Number of attached reading processes currently processing events.

Definition at line 30 of file RingBuffer.h.

◆ ninsq

int ninsq

Count insq() calls for this buffer.

Definition at line 34 of file RingBuffer.h.

◆ nremq

int nremq

Count remq() calls for this buffer.

Definition at line 35 of file RingBuffer.h.

◆ numAttachedTx

int numAttachedTx

number of attached sending processes.

0: Processes reading from this buffer should terminate once it's empty. -1: attach pending (initial state)

Definition at line 33 of file RingBuffer.h.

◆ prevwptr

int prevwptr

Previous state of wptr (for error recovery).

Definition at line 25 of file RingBuffer.h.

◆ remain

int remain

Unsure, always equal to size.

Definition at line 23 of file RingBuffer.h.

◆ rptr

int rptr

Pointer for reading entries.

Definition at line 26 of file RingBuffer.h.

◆ semid

int semid

Semaphore ID.

Definition at line 28 of file RingBuffer.h.

◆ size

int size

ring buffer size (integers), minus this header.

Definition at line 22 of file RingBuffer.h.

◆ wptr

int wptr

Pointer for writing entries.

Definition at line 24 of file RingBuffer.h.


The documentation for this struct was generated from the following file: