Incrementally reads one network-order, 32-bit length-prefixed frame. More...

#include <cpp/symbian/agent/frame.h>

Public Member Functions
	FrameDecoder (std::size_t maximum_frame_bytes=kMaximumFrameBytes)

std::size_t	buffered_bytes () const
	Number of payload bytes already buffered for the current frame.

void	Reset ()
	Clear an incomplete frame after disconnect or cancellation.

absl::StatusOr< std::size_t >	Consume (std::span< const std::uint8_t > bytes, std::optional< Frame > *completed)
	Consume at most one frame from `bytes`.

Detailed Description

Incrementally reads one network-order, 32-bit length-prefixed frame.

No payload buffer is allocated until the complete four-byte prefix has been checked against the configured limit. A zero length is invalid. The caller must authenticate its transport before handing frames to a request parser; this class does not grant permissions or interpret MessagePack.

Constructor & Destructor Documentation

◆ FrameDecoder()

symbian::agent::FrameDecoder::FrameDecoder ( std::size_t maximum_frame_bytes = kMaximumFrameBytes )

explicit

Member Function Documentation

◆ buffered_bytes()

std::size_t symbian::agent::FrameDecoder::buffered_bytes ( ) const

inline

Number of payload bytes already buffered for the current frame.

◆ Consume()

absl::StatusOr< std::size_t > symbian::agent::FrameDecoder::Consume	(	std::span< const std::uint8_t >	bytes,
		std::optional< Frame > *	completed
	)

Consume at most one frame from bytes.

Parameters

bytes	Input bytes; any unused suffix belongs to the next frame.
completed	Receives a frame when this call completes one.

Returns: Number of bytes consumed, or InvalidArgument for a bad prefix. After an error, call Reset before accepting further input.

◆ Reset()

void symbian::agent::FrameDecoder::Reset ( )

Clear an incomplete frame after disconnect or cancellation.

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

cpp/symbian/agent/frame.h
cpp/symbian/agent/frame.cc