abstract class representing a framing protocol More...

#include <Svc/FramingProtocol/FramingProtocol.hpp>

Inheritance diagram for Svc::FramingProtocol:

Public Member Functions
	FramingProtocol ()
	constructor More...

virtual	~FramingProtocol ()

void	setup (FramingProtocolInterface &interface)
	setup function called to supply the interface used for allocation and sending More...

virtual void	frame (const U8 *const data, const U32 size, Fw::ComPacket::ComPacketType packet_type)=0
	frame a given set of bytes More...

Protected Attributes
FramingProtocolInterface *	m_interface

Detailed Description

abstract class representing a framing protocol

This class defines the methods used to create a framed packet from Com and Fw::Buffers. The framing protocol frame method is called with data and it in turn is expected to call the send method of m_interface once a packet is constructed.

There is no requirement that this be one-to-one and thus packetization, aggregation may all be performed. A call to m_interface.allocate can allocate memory such that framing tokens may be added.

Definition at line 31 of file FramingProtocol.hpp.

Constructor & Destructor Documentation

◆ FramingProtocol()

Svc::FramingProtocol::FramingProtocol ( )

constructor

Definition at line 19 of file FramingProtocol.cpp.

◆ ~FramingProtocol()

virtual Svc::FramingProtocol::~FramingProtocol ( )

inlinevirtual

Definition at line 36 of file FramingProtocol.hpp.

Member Function Documentation

◆ frame()

virtual void Svc::FramingProtocol::frame	(	const U8 *const	data,
		const U32	size,
		Fw::ComPacket::ComPacketType	packet_type
	)

pure virtual

frame a given set of bytes

Parameters

data	pointer to a set of bytes to be framed
size	size of data pointed to by `data`
packet_type	type of data supplied for File downlink packets

Implemented in Svc::FprimeFraming.

◆ setup()

void Svc::FramingProtocol::setup ( FramingProtocolInterface & interface )

setup function called to supply the interface used for allocation and sending

Parameters

interface interface implementation, normally FramerComponentImpl

Definition at line 21 of file FramingProtocol.cpp.

Member Data Documentation

◆ m_interface

FramingProtocolInterface* Svc::FramingProtocol::m_interface

protected

Definition at line 49 of file FramingProtocol.hpp.

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

Svc/FramingProtocol/FramingProtocol.hpp
Svc/FramingProtocol/FramingProtocol.cpp

Public Member Functions

Protected Attributes