utrace::Ring_status< SEQUENCE_TYPE > Class Template Reference

Ring buffer status area. More...

#include <ring_buffer>

Inheritance diagram for utrace::Ring_status< SEQUENCE_TYPE >:

Collaboration diagram for utrace::Ring_status< SEQUENCE_TYPE >:

Public Member Functions
unsigned	version () const
	Get the version of the ring buffer items.
size_t	alignment () const
	Get the stable alignment of the ring buffer status members.
size_t	mask () const
	Get the item mask.
size_t	items () const
	Get the number of items.

Detailed Description

template<typename SEQUENCE_TYPE>
class utrace::Ring_status< SEQUENCE_TYPE >

Ring buffer status area.

The ring buffer status area contains run-time configuration information of the ring buffer, most notably the current atomic generation counter (i.e. the last sequence number allocated to an item).

This structure is only written by the producers, it is read-only for the consumers.

Template Parameters

SEQUENCE_TYPE

Numerical type for storing sequence and generation counters. Must be suitable for atomic access.

Definition at line 128 of file ring_buffer.

Member Function Documentation

alignment()

template<typename SEQUENCE_TYPE>

size_t utrace::Ring_status< SEQUENCE_TYPE >::alignment ( ) const

inline

Get the stable alignment of the ring buffer status members.

This is relevant for the _mask and _tail members.

Returns

Stable alignment of the ring buffer status members.

Definition at line 155 of file ring_buffer.

version()

template<typename SEQUENCE_TYPE>

unsigned utrace::Ring_status< SEQUENCE_TYPE >::version ( ) const

inline

Get the version of the ring buffer items.

The semantics of the version number is defined by the user.

Returns

Version of the ring buffer items.

Definition at line 145 of file ring_buffer.

---

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

• l4/utrace/ring_buffer