rogue::protocols::packetizer::Core Class Reference

Packetizer core wiring object. More...

#include <Core.h>

Public Member Functions
	Core (bool enSsi)
	Constructs a packetizer core.
	~Core ()
	Destroys the packetizer core.
std::shared_ptr< rogue::protocols::packetizer::Transport >	transport ()
	Returns the transport-facing endpoint.
std::shared_ptr< rogue::protocols::packetizer::Application >	application (uint8_t dest)
	Returns an application endpoint by destination ID.
uint32_t	getDropCount ()
	Returns total dropped-frame count reported by the controller.
void	setTimeout (uint32_t timeout)
	Sets transmit timeout for internal controller operations.

Static Public Member Functions
static std::shared_ptr< rogue::protocols::packetizer::Core >	create (bool enSsi)
	Creates a packetizer core.
static void	setup_python ()
	Registers Python bindings for this class.

Detailed Description

Packetizer core wiring object.

Owns and connects transport, controller, and per-destination application endpoints for the packetizer v1 stack.

Definition at line 41 of file Core.h.

Constructor & Destructor Documentation

Core()

rogue::protocols::packetizer::Core::Core ( bool  enSsi )

explicit

Constructs a packetizer core.

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.

Definition at line 54 of file Core.cpp.

~Core()

rogue::protocols::packetizer::Core::~Core

(

)

Destroys the packetizer core.

Destructor.

Definition at line 62 of file Core.cpp.

Member Function Documentation

application()

rogue::protocols::packetizer::ApplicationPtr rogue::protocols::packetizer::Core::application

(

uint8_t

dest

)

Returns an application endpoint by destination ID.

Application module.

Parameters

dest	Destination channel ID.

Returns

Shared application endpoint.

Definition at line 77 of file Core.cpp.

create()

rogue::protocols::packetizer::CorePtr rogue::protocols::packetizer::Core::create ( bool  enSsi )

static

Creates a packetizer core.

Class creation.

Parameter semantics are identical to the constructor; see Core() for core-construction 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.

Returns

Shared pointer to the created packetizer core.

---

Company : SLAC National Accelerator Laboratory

Description:

Packetizer Core

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 38 of file Core.cpp.

getDropCount()

uint32_t rogue::protocols::packetizer::Core::getDropCount

(

)

Returns total dropped-frame count reported by the controller.

Get drop count.

Returns

Number of dropped frames.

Definition at line 86 of file Core.cpp.

setTimeout()

void rogue::protocols::packetizer::Core::setTimeout

(

uint32_t

timeout

)

Sets transmit timeout for internal controller operations.

Parameters

timeout

Timeout in microseconds.

Definition at line 90 of file Core.cpp.

setup_python()

void rogue::protocols::packetizer::Core::setup_python ( )

static

Registers Python bindings for this class.

Definition at line 43 of file Core.cpp.

transport()

rogue::protocols::packetizer::TransportPtr rogue::protocols::packetizer::Core::transport

(

)

Returns the transport-facing endpoint.

Get transport interface.

Returns

Shared transport interface.

Definition at line 72 of file Core.cpp.

---

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

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