Packetizer controller implementation for protocol v1. More...

#include <ControllerV1.h>

Inheritance diagram for rogue::protocols::packetizer::ControllerV1:

Public Member Functions
	ControllerV1 (bool enSsi, std::shared_ptr< rogue::protocols::packetizer::Transport > tran, std::shared_ptr< rogue::protocols::packetizer::Application > *app)
	Constructs a packetizer v1 controller.

	~ControllerV1 ()
	Destroys the controller instance.

void	transportRx (std::shared_ptr< rogue::interfaces::stream::Frame > frame)
	Processes a frame received at the transport interface.

void	applicationRx (std::shared_ptr< rogue::interfaces::stream::Frame > frame, uint8_t id)
	Processes a frame received from one application endpoint.

Public Member Functions inherited from rogue::protocols::packetizer::Controller
	Controller (std::shared_ptr< rogue::protocols::packetizer::Transport > tran, std::shared_ptr< rogue::protocols::packetizer::Application > *app, uint32_t headSize, uint32_t tailSize, uint32_t alignSize, bool enSsi)
	Constructs a packetizer controller base.

	~Controller ()
	Destroys the packetizer controller base.

std::shared_ptr< rogue::interfaces::stream::Frame >	reqFrame (uint32_t size)
	Allocates a transport-path frame.

void	stopQueue ()
	Stops the internal transmit queue.

void	stop ()
	Stops controller processing.

std::shared_ptr< rogue::interfaces::stream::Frame >	transportTx ()
	Returns the next frame for transport transmission.

uint32_t	getDropCount ()
	Returns dropped-frame counter.

void	setTimeout (uint32_t timeout)
	Sets timeout in microseconds for frame transmits.

Public Member Functions inherited from rogue::EnableSharedFromThis< rogue::protocols::packetizer::ControllerV1 >
std::shared_ptr< rogue::protocols::packetizer::ControllerV1 >	shared_from_this ()
	Returns a `shared_ptr<T>` for this instance.

Public Member Functions inherited from rogue::EnableSharedFromThisBase
virtual	~EnableSharedFromThisBase ()
	Virtual destructor for polymorphic base usage.

Static Public Member Functions
static std::shared_ptr< rogue::protocols::packetizer::ControllerV1 >	create (bool enSsi, std::shared_ptr< rogue::protocols::packetizer::Transport > tran, std::shared_ptr< rogue::protocols::packetizer::Application > *app)
	Creates a packetizer v1 controller.

Additional Inherited Members
Protected Attributes inherited from rogue::protocols::packetizer::Controller
bool	enSsi_

uint32_t	appIndex_

uint32_t	tranIndex_

bool	transSof_ [256]

uint32_t	tranCount_ [256]

uint32_t	crc_ [256]

uint8_t	tranDest_

uint32_t	dropCount_

uint32_t	headSize_

uint32_t	tailSize_

uint32_t	alignSize_

struct timeval	timeout_

std::shared_ptr< rogue::Logging >	log_

std::shared_ptr< rogue::interfaces::stream::Frame >	tranFrame_ [256]

std::mutex	appMtx_

std::mutex	tranMtx_

std::shared_ptr< rogue::protocols::packetizer::Transport >	tran_

std::shared_ptr< rogue::protocols::packetizer::Application > *	app_

rogue::Queue< std::shared_ptr< rogue::interfaces::stream::Frame > >	tranQueue_

Detailed Description

Packetizer controller implementation for protocol v1.

Implements packetizer v1 frame parsing and assembly between the transport endpoint and per-destination application endpoints.

Definition at line 47 of file ControllerV1.h.

Constructor & Destructor Documentation

◆ ControllerV1()

rogue::protocols::packetizer::ControllerV1::ControllerV1	(	bool	enSsi,
		std::shared_ptr< rogue::protocols::packetizer::Transport >	tran,
		std::shared_ptr< rogue::protocols::packetizer::Application > *	app
	)

Constructs a packetizer v1 controller.

Creator.

This constructor is a low-level C++ allocation path. Prefer create() when shared ownership or Python exposure is required.

Parameters

enSsi	Enable SSI framing behavior.
tran	Transport endpoint attached to this controller.
app	Pointer to array of application endpoints indexed by destination.

Definition at line 45 of file ControllerV1.cpp.

◆ ~ControllerV1()

rogue::protocols::packetizer::ControllerV1::~ControllerV1 ( )

Destroys the controller instance.

Destructor.

Definition at line 49 of file ControllerV1.cpp.

Member Function Documentation

◆ applicationRx()

void rogue::protocols::packetizer::ControllerV1::applicationRx	(	std::shared_ptr< rogue::interfaces::stream::Frame >	frame,
		uint8_t	id
	)

virtual

Processes a frame received from one application endpoint.

Frame received at application interface.

Parameters

frame	Application frame to packetize.
id	Application/destination identifier.

Reimplemented from rogue::protocols::packetizer::Controller.

Definition at line 181 of file ControllerV1.cpp.

◆ create()

rogue::protocols::packetizer::ControllerV1Ptr rogue::protocols::packetizer::ControllerV1::create	(	bool	enSsi,
		std::shared_ptr< rogue::protocols::packetizer::Transport >	tran,
		std::shared_ptr< rogue::protocols::packetizer::Application > *	app
	)

static

Creates a packetizer v1 controller.

Class creation.

Parameter semantics are identical to the constructor; see ControllerV1() for construction-path details. This static factory is the preferred construction path when the object is shared across Rogue graph connections or exposed to Python. It returns std::shared_ptr ownership compatible with Rogue pointer typedefs.

Parameters

enSsi	Enable SSI framing behavior.
tran	Transport endpoint attached to this controller.
app	Pointer to array of application endpoints indexed by destination.

Returns: Shared pointer to a new controller instance.

Company : SLAC National Accelerator Laboratory

Description:

Packetizer Controller V1

This file is part of the rogue software platform. It is subject to the license terms in the LICENSE.txt file found in the top-level directory of this distribution and at: https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. No part of the rogue software platform, including this file, may be copied, modified, propagated, or distributed except according to the terms

contained in the LICENSE.txt file.

Definition at line 39 of file ControllerV1.cpp.

◆ transportRx()

void rogue::protocols::packetizer::ControllerV1::transportRx ( std::shared_ptr< rogue::interfaces::stream::Frame > frame )

virtual

Processes a frame received at the transport interface.

Frame received at transport interface.

Parameters

frame Transport frame to decode and route.

Reimplemented from rogue::protocols::packetizer::Controller.

Definition at line 52 of file ControllerV1.cpp.

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

/home/runner/work/rogue/rogue/include/rogue/protocols/packetizer/ControllerV1.h
/home/runner/work/rogue/rogue/src/rogue/protocols/packetizer/ControllerV1.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ControllerV1()

◆ ~ControllerV1()

Member Function Documentation

◆ applicationRx()

◆ create()

Company : SLAC National Accelerator Laboratory

Packetizer Controller V1

contained in the LICENSE.txt file.

◆ transportRx()