IFramer Class Reference

Space-ng SDK: sol3::net::IFramer Class Reference
Space-ng SDK
sol3::net::IFramer Class Referenceabstract

#include <sol3/net/framer.h>

Classes

struct  FrameSpan
 

Public Member Functions

virtual ~IFramer ()=default
 
virtual std::size_t nextReadLength () const =0
 
virtual std::optional< FrameSpanconsume (uint8_t const *data, std::size_t n)=0
 
virtual void frameInto (std::vector< uint8_t > &out, uint8_t const *data, std::size_t n) const =0
 
virtual std::unique_ptr< IFramerclone () const =0
 

Constructor & Destructor Documentation

◆ ~IFramer()

virtual sol3::net::IFramer::~IFramer ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual std::unique_ptr<IFramer> sol3::net::IFramer::clone ( ) const
pure virtual

◆ consume()

virtual std::optional<FrameSpan> sol3::net::IFramer::consume ( uint8_t const *  data,
std::size_t  n 
)
pure virtual

◆ frameInto()

virtual void sol3::net::IFramer::frameInto ( std::vector< uint8_t > &  out,
uint8_t const *  data,
std::size_t  n 
) const
pure virtual

◆ nextReadLength()

virtual std::size_t sol3::net::IFramer::nextReadLength ( ) const
pure virtual

The documentation for this class was generated from the following file:
  • /workspaces/astro/sol3-sdk/cpp/sol3/net/framer.h