roo_transport
API Documentation for roo_transport
Loading...
Searching...
No Matches
Public Member Functions
roo_transport::internal::RingBuffer Class Reference

#include <ring_buffer.h>

Public Member Functions

 RingBuffer (int capacity_log2, uint16_t initial_seq=0)
 
uint16_t slotsUsed () const
 
uint16_t slotsFree () const
 
SeqNum begin () const
 
SeqNum end () const
 
SeqNum push ()
 
SeqNum pop ()
 
bool empty () const
 
void reset (SeqNum seq)
 
bool contains (SeqNum seq) const
 
uint16_t offset_for (SeqNum seq) const
 
SeqNum restorePosHighBits (uint16_t truncated_pos, int pos_bits)
 
int capacity_log2 () const
 
uint16_t capacity () const
 

Detailed Description

Definition at line 14 of file ring_buffer.h.

Constructor & Destructor Documentation

◆ RingBuffer()

roo_transport::internal::RingBuffer::RingBuffer ( int  capacity_log2,
uint16_t  initial_seq = 0 
)
inline

Definition at line 16 of file ring_buffer.h.

References capacity_log2().

Member Function Documentation

◆ begin()

SeqNum roo_transport::internal::RingBuffer::begin ( ) const
inline

Definition at line 25 of file ring_buffer.h.

Referenced by roo_transport::internal::Transmitter::ack(), roo_transport::internal::Receiver::availableForRead(), roo_transport::internal::Transmitter::front(), roo_transport::internal::Transmitter::getBufferToSend(), roo_transport::internal::Receiver::handleDataPacket(), roo_transport::internal::Transmitter::init(), roo_transport::internal::Receiver::peek(), roo_transport::internal::Receiver::reset(), roo_transport::internal::Transmitter::setConnected(), roo_transport::internal::Receiver::tryRead(), and roo_transport::internal::Receiver::updateRecvHimark().

◆ capacity()

uint16_t roo_transport::internal::RingBuffer::capacity ( ) const
inline

Definition at line 65 of file ring_buffer.h.

Referenced by offset_for(), slotsFree(), and roo_transport::internal::Receiver::updateRecvHimark().

◆ capacity_log2()

int roo_transport::internal::RingBuffer::capacity_log2 ( ) const
inline

Definition at line 64 of file ring_buffer.h.

Referenced by roo_transport::internal::Receiver::buffer_size_log2(), and RingBuffer().

◆ contains()

bool roo_transport::internal::RingBuffer::contains ( SeqNum  seq) const
inline

Definition at line 47 of file ring_buffer.h.

Referenced by roo_transport::internal::Transmitter::ack(), roo_transport::internal::Receiver::ack(), roo_transport::internal::Transmitter::getBufferToSend(), roo_transport::internal::Receiver::handleDataPacket(), and offset_for().

◆ empty()

bool roo_transport::internal::RingBuffer::empty ( ) const
inline

Definition at line 38 of file ring_buffer.h.

References slotsUsed().

Referenced by roo_transport::internal::Transmitter::ack(), roo_transport::internal::Receiver::availableForRead(), roo_transport::internal::Receiver::empty(), roo_transport::internal::Receiver::handleDataPacket(), roo_transport::internal::Transmitter::hasPendingData(), roo_transport::internal::Receiver::init(), roo_transport::internal::Transmitter::init(), roo_transport::internal::Receiver::markInputClosed(), roo_transport::internal::Receiver::peek(), roo_transport::internal::Receiver::reset(), roo_transport::internal::Transmitter::reset(), roo_transport::internal::Receiver::setBroken(), roo_transport::internal::Transmitter::setBroken(), roo_transport::internal::Receiver::setConnected(), and roo_transport::internal::Receiver::tryRead().

◆ end()

SeqNum roo_transport::internal::RingBuffer::end ( ) const
inline

Definition at line 26 of file ring_buffer.h.

Referenced by roo_transport::internal::Transmitter::ack(), roo_transport::internal::Transmitter::getBufferToSend(), roo_transport::internal::Receiver::handleDataPacket(), roo_transport::internal::Transmitter::tryWrite(), and roo_transport::internal::Transmitter::updateRecvHimark().

◆ offset_for()

uint16_t roo_transport::internal::RingBuffer::offset_for ( SeqNum  seq) const
inline

Definition at line 49 of file ring_buffer.h.

References capacity(), contains(), and roo_transport::internal::SeqNum::raw().

◆ pop()

SeqNum roo_transport::internal::RingBuffer::pop ( )
inline

Definition at line 33 of file ring_buffer.h.

References slotsUsed().

Referenced by roo_transport::internal::Transmitter::ack(), roo_transport::internal::Receiver::handleDataPacket(), roo_transport::internal::Receiver::init(), roo_transport::internal::Transmitter::init(), roo_transport::internal::Receiver::markInputClosed(), roo_transport::internal::Receiver::reset(), roo_transport::internal::Transmitter::reset(), roo_transport::internal::Transmitter::setBroken(), and roo_transport::internal::Receiver::tryRead().

◆ push()

SeqNum roo_transport::internal::RingBuffer::push ( )
inline

Definition at line 28 of file ring_buffer.h.

References slotsFree().

Referenced by roo_transport::internal::Receiver::handleDataPacket(), and roo_transport::internal::Transmitter::tryWrite().

◆ reset()

void roo_transport::internal::RingBuffer::reset ( SeqNum  seq)
inline

Definition at line 40 of file ring_buffer.h.

Referenced by roo_transport::internal::Transmitter::init(), and roo_transport::internal::Receiver::setConnected().

◆ restorePosHighBits()

SeqNum roo_transport::internal::RingBuffer::restorePosHighBits ( uint16_t  truncated_pos,
int  pos_bits 
)
inline

Definition at line 58 of file ring_buffer.h.

References roo_transport::internal::SeqNum::raw().

Referenced by roo_transport::internal::Transmitter::ack(), roo_transport::internal::Receiver::handleDataPacket(), and roo_transport::internal::Transmitter::updateRecvHimark().

◆ slotsFree()

uint16_t roo_transport::internal::RingBuffer::slotsFree ( ) const
inline

Definition at line 23 of file ring_buffer.h.

References capacity(), and slotsUsed().

Referenced by roo_transport::internal::Transmitter::availableForWrite(), roo_transport::internal::Transmitter::close(), roo_transport::internal::Receiver::handleDataPacket(), push(), and roo_transport::internal::Transmitter::tryWrite().

◆ slotsUsed()

uint16_t roo_transport::internal::RingBuffer::slotsUsed ( ) const
inline

Definition at line 21 of file ring_buffer.h.

Referenced by empty(), roo_transport::internal::Transmitter::getBufferToSend(), pop(), slotsFree(), and roo_transport::internal::Receiver::tryRead().

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