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

#include <receiver.h>

Public Types

enum  State { kIdle = 0 , kConnecting = 1 , kConnected = 2 , kBroken = 3 }
 

Public Member Functions

 Receiver (unsigned int recvbuf_log2)
 
State state () const
 
bool eos () const
 
bool done () const
 
void setConnected (SeqNum peer_seq_num, bool control_bit)
 
void setIdle ()
 
void setBroken ()
 
size_t tryRead (roo::byte *buf, size_t count, bool &outgoing_data_ready)
 
int peek ()
 
size_t availableForRead () const
 
void reset ()
 
void init (uint32_t my_stream_id)
 
void markInputClosed (bool &outgoing_data_ready)
 
size_t ack (roo::byte *buf)
 
size_t updateRecvHimark (roo::byte *buf, long &next_send_micros)
 
bool handleDataPacket (bool control_bit, uint16_t seq_id, const roo::byte *payload, size_t len, bool is_final, bool &has_new_data_to_read)
 
bool empty () const
 
uint32_t packets_received () const
 
uint32_t my_stream_id () const
 
unsigned int buffer_size_log2 () const
 

Detailed Description

Definition at line 11 of file receiver.h.

Member Enumeration Documentation

◆ State

enum roo_transport::internal::Receiver::State
Enumerator
kIdle 
kConnecting 
kConnected 
kBroken 

Definition at line 13 of file receiver.h.

Constructor & Destructor Documentation

◆ Receiver()

roo_transport::internal::Receiver::Receiver ( unsigned int  recvbuf_log2)

Definition at line 9 of file receiver.cpp.

Member Function Documentation

◆ ack()

size_t roo_transport::internal::Receiver::ack ( roo::byte *  buf)

Definition at line 195 of file receiver.cpp.

References roo_transport::internal::RingBuffer::contains(), roo_transport::internal::FormatPacketHeader(), kConnected, roo_transport::internal::kDataAckPacket, kIdle, and roo_transport::internal::InBuffer::kUnset.

◆ availableForRead()

size_t roo_transport::internal::Receiver::availableForRead ( ) const

Definition at line 125 of file receiver.cpp.

References roo_transport::internal::RingBuffer::begin(), roo_transport::internal::RingBuffer::empty(), roo_transport::internal::InBuffer::kData, roo_transport::internal::InBuffer::kFin, roo_transport::internal::InBuffer::kUnset, roo_transport::internal::InBuffer::size(), and roo_transport::internal::InBuffer::type().

◆ buffer_size_log2()

unsigned int roo_transport::internal::Receiver::buffer_size_log2 ( ) const
inline

Definition at line 65 of file receiver.h.

References roo_transport::internal::RingBuffer::capacity_log2().

◆ done()

bool roo_transport::internal::Receiver::done ( ) const

Definition at line 50 of file receiver.cpp.

References empty().

◆ empty()

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

Definition at line 58 of file receiver.h.

References roo_transport::internal::RingBuffer::empty().

Referenced by done().

◆ eos()

bool roo_transport::internal::Receiver::eos ( ) const
inline

Definition at line 33 of file receiver.h.

◆ handleDataPacket()

bool roo_transport::internal::Receiver::handleDataPacket ( bool  control_bit,
uint16_t  seq_id,
const roo::byte *  payload,
size_t  len,
bool  is_final,
bool &  has_new_data_to_read 
)

Definition at line 231 of file receiver.cpp.

References roo_transport::internal::RingBuffer::begin(), roo_transport::internal::InBuffer::clear(), roo_transport::internal::RingBuffer::contains(), roo_transport::internal::RingBuffer::empty(), roo_transport::internal::RingBuffer::end(), kConnecting, roo_transport::internal::InBuffer::kData, roo_transport::internal::InBuffer::kFin, kIdle, roo_transport::internal::InBuffer::kUnset, roo_transport::internal::RingBuffer::pop(), roo_transport::internal::RingBuffer::push(), roo_transport::internal::RingBuffer::restorePosHighBits(), roo_transport::internal::InBuffer::set(), roo_transport::internal::RingBuffer::slotsFree(), and roo_transport::internal::InBuffer::type().

◆ init()

void roo_transport::internal::Receiver::init ( uint32_t  my_stream_id)

Definition at line 163 of file receiver.cpp.

References roo_transport::internal::RingBuffer::empty(), kConnecting, my_stream_id(), and roo_transport::internal::RingBuffer::pop().

◆ markInputClosed()

void roo_transport::internal::Receiver::markInputClosed ( bool &  outgoing_data_ready)

Definition at line 101 of file receiver.cpp.

References roo_transport::internal::RingBuffer::empty(), and roo_transport::internal::RingBuffer::pop().

◆ my_stream_id()

uint32_t roo_transport::internal::Receiver::my_stream_id ( ) const
inline

Definition at line 62 of file receiver.h.

Referenced by init().

◆ packets_received()

uint32_t roo_transport::internal::Receiver::packets_received ( ) const
inline

Definition at line 60 of file receiver.h.

◆ peek()

int roo_transport::internal::Receiver::peek ( )

Definition at line 111 of file receiver.cpp.

References roo_transport::internal::RingBuffer::begin(), roo_transport::internal::InBuffer::data(), roo_transport::internal::RingBuffer::empty(), roo_transport::internal::InBuffer::kData, roo_transport::internal::InBuffer::size(), and roo_transport::internal::InBuffer::type().

◆ reset()

void roo_transport::internal::Receiver::reset ( )

Definition at line 147 of file receiver.cpp.

References roo_transport::internal::RingBuffer::begin(), roo_transport::internal::InBuffer::clear(), roo_transport::internal::RingBuffer::empty(), kIdle, and roo_transport::internal::RingBuffer::pop().

◆ setBroken()

void roo_transport::internal::Receiver::setBroken ( )

Definition at line 40 of file receiver.cpp.

References roo_transport::internal::RingBuffer::empty(), and setIdle().

◆ setConnected()

void roo_transport::internal::Receiver::setConnected ( SeqNum  peer_seq_num,
bool  control_bit 
)

Definition at line 25 of file receiver.cpp.

References roo_transport::internal::RingBuffer::empty(), kConnected, roo_transport::internal::SeqNum::raw(), and roo_transport::internal::RingBuffer::reset().

◆ setIdle()

void roo_transport::internal::Receiver::setIdle ( )

Definition at line 33 of file receiver.cpp.

References kIdle.

Referenced by setBroken(), and tryRead().

◆ state()

State roo_transport::internal::Receiver::state ( ) const
inline

Definition at line 32 of file receiver.h.

◆ tryRead()

size_t roo_transport::internal::Receiver::tryRead ( roo::byte *  buf,
size_t  count,
bool &  outgoing_data_ready 
)

Definition at line 54 of file receiver.cpp.

References roo_transport::internal::RingBuffer::begin(), roo_transport::internal::InBuffer::clear(), roo_transport::internal::InBuffer::data(), roo_transport::internal::RingBuffer::empty(), kBroken, kConnecting, roo_transport::internal::InBuffer::kFin, kIdle, roo_transport::internal::InBuffer::kUnset, roo_transport::internal::RingBuffer::pop(), setIdle(), roo_transport::internal::InBuffer::size(), roo_transport::internal::RingBuffer::slotsUsed(), and roo_transport::internal::InBuffer::type().

◆ updateRecvHimark()

size_t roo_transport::internal::Receiver::updateRecvHimark ( roo::byte *  buf,
long &  next_send_micros 
)

Definition at line 174 of file receiver.cpp.

References roo_transport::internal::RingBuffer::begin(), roo_transport::internal::RingBuffer::capacity(), roo_transport::internal::FormatPacketHeader(), kConnecting, roo_transport::internal::kFlowControlPacket, and kIdle.

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