Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. Comms
  5. pw_cobs
  6. pw::cobs::StreamerBuffer< kSizeBytes > Class Template Reference
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
pw::cobs::StreamerBuffer< kSizeBytes > Class Template Reference
Comms » pw_cobs

Overview

template<size_t kSizeBytes = Streamer::kMinBufferSize>
class pw::cobs::StreamerBuffer< kSizeBytes >

A Streamer with an inline output buffer of kSizeBytes bytes (defaulting to Streamer::kMinBufferSize = 257 bytes).

Inheritance diagram for pw::cobs::StreamerBuffer< kSizeBytes >:
pw::containers::StorageBase< kAlignment, kSizeBytes > pw::cobs::Streamer

Public Member Functions

constexpr StreamerBuffer (bool emit_leading_delimiter=false)
 
 StreamerBuffer (const StreamerBuffer &)=delete
 
StreamerBuffer & operator= (const StreamerBuffer &)=delete
 
 StreamerBuffer (StreamerBuffer &&)=delete
 
StreamerBuffer & operator= (StreamerBuffer &&)=delete
 
- Public Member Functions inherited from pw::cobs::Streamer
constexpr Streamer (ByteSpan buffer, bool emit_leading_delimiter=false)
 
constexpr void Reset (bool emit_leading_delimiter=false)
 
ConstByteSpan Write (ConstByteSpan data)
 
ByteSpan Flush ()
 
ByteSpan Finish ()
 
constexpr ConstByteSpan AbortSequence () const
 

Static Public Member Functions

static constexpr size_t max_size ()
 

Additional Inherited Members

- Static Public Attributes inherited from pw::cobs::Streamer
static constexpr size_t kMinBufferSize = MaxEncodedSize(kMaxRunLength) + 1
 
static constexpr std::array< std::byte, 2 > kAbortSequence
 
The documentation for this class was generated from the following file: