Svc::Deframer Class Reference

Generic deframing component using DeframingProtocol implementation for actual deframing. More...

#include <Svc/Deframer/Deframer.hpp>

Inheritance diagram for Svc::Deframer:

Public Member Functions
	Deframer (const char *const compName)
	Construct Deframer instance.
void	init (const NATIVE_INT_TYPE instance=0)
	Initialize Deframer instance.
	~Deframer ()
	Destroy Deframer instance.
void	setup (DeframingProtocol &protocol)
	Set up the instance.
Public Member Functions inherited from Svc::DeframingProtocolInterface
virtual	~DeframingProtocolInterface ()
virtual Fw::Buffer	allocate (const U32 size)=0
	called to allocate memory, typically delegating to an allocate port call
virtual void	route (Fw::Buffer &data)=0
	send deframed data into the system

Detailed Description

Generic deframing component using DeframingProtocol implementation for actual deframing.

Deframing component used to take byte streams and expand them into Com/File buffers. This is done using a deframing protocol specified in a DeframingProtocol instance. The instance must be supplied using the setup method.

Using this component, projects can implement and supply a fresh DeframingProtocol implementation without changing the reference topology.

Implementation uses a circular buffer to store incoming data, which is drained one framed packet at a time into buffers dispatched to the rest of the system.

Definition at line 37 of file Deframer.hpp.

Constructor & Destructor Documentation

Deframer()

Svc::Deframer::Deframer

(

const char *const

compName

)

Construct Deframer instance.

Parameters

compName

The component name

Definition at line 39 of file Deframer.cpp.

~Deframer()

Svc::Deframer::~Deframer

(

)

Destroy Deframer instance.

Definition at line 52 of file Deframer.cpp.

Member Function Documentation

init()

void Svc::Deframer::init

(

const NATIVE_INT_TYPE

instance = 0

)

Initialize Deframer instance.

Parameters

instance

The instance number

Definition at line 48 of file Deframer.cpp.

setup()

void Svc::Deframer::setup

(

DeframingProtocol &

protocol

)

Set up the instance.

Parameters

protocol

Deframing protocol instance

Definition at line 54 of file Deframer.cpp.

---

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

• Svc/Deframer/Deframer.hpp
• Svc/Deframer/Deframer.cpp