framer.h

Go to the documentation of this file.

// Copyright (c) Space-ng, inc. All rights reserved.
 
#pragma once
 
#include <cstdint>
#include <memory>
#include <optional>
#include <vector>
 
namespace sol3::net {
 
// Frames a payload in a stream of bytes
class IFramer {
 public:
  virtual ~IFramer() = default;
 
  // A view of a Frame
  struct FrameSpan {
    uint8_t const* data;
    std::size_t size;
  };
 
  // The number of bytes to read next.
  // The next call to `consume()` must match exactly this number of bytes.
  virtual std::size_t nextReadLength() const = 0;
 
  // Feeds `n` bytes, where `n` matches the last value of `nextReadLength()`.
  // Returns a frame view if a frame has been found.
  virtual std::optional<FrameSpan> consume(
      uint8_t const* data, std::size_t n) = 0;
 
  // Frame a payload into caller-owned storage
  virtual void frameInto(
      std::vector<uint8_t>& out, uint8_t const* data, std::size_t n) const = 0;
 
  // Clone with no internal state
  virtual std::unique_ptr<IFramer> clone() const = 0;
};
 
}  // namespace sol3::net