RSSI application-side endpoint. More...

#include <Application.h>

Inheritance diagram for rogue::protocols::rssi::Application:

Public Member Functions
	Application ()
	Constructs an RSSI application endpoint.

	~Application ()
	Destroys the application endpoint.

void	setController (std::shared_ptr< rogue::protocols::rssi::Controller > cntl)
	Attaches the RSSI controller.

std::shared_ptr< rogue::interfaces::stream::Frame >	acceptReq (uint32_t size, bool zeroCopyEn)
	Allocates a frame for upstream writers.

void	acceptFrame (std::shared_ptr< rogue::interfaces::stream::Frame > frame)
	Accepts a frame from upstream application logic.

Public Member Functions inherited from rogue::interfaces::stream::Master
	Master ()
	Constructs a stream master.

virtual	~Master ()
	Destroys the stream master.

uint32_t	slaveCount ()
	Returns the number of attached slaves.

void	addSlave (std::shared_ptr< rogue::interfaces::stream::Slave > slave)
	Attaches a downstream slave.

std::shared_ptr< rogue::interfaces::stream::Frame >	reqFrame (uint32_t size, bool zeroCopyEn)
	Requests allocation of a new frame from the primary slave.

void	sendFrame (std::shared_ptr< rogue::interfaces::stream::Frame > frame)
	Sends a frame to all attached slaves.

bool	ensureSingleBuffer (std::shared_ptr< rogue::interfaces::stream::Frame > &frame, bool reqEn)
	Ensures a frame is represented by a single buffer.

virtual void	stop ()
	Stops frame generation and shuts down associated threads.

void	equalsPy (boost::python::object p)
	Supports `==` operator usage from Python.

boost::python::object	rshiftPy (boost::python::object p)
	Supports `>>` operator usage from Python.

void	operator== (std::shared_ptr< rogue::interfaces::stream::Slave > &other)
	Supports `==` operator usage in C++.

std::shared_ptr< rogue::interfaces::stream::Slave > &	operator>> (std::shared_ptr< rogue::interfaces::stream::Slave > &other)
	Connects this master to a slave via stream chaining operator.

Public Member Functions inherited from rogue::EnableSharedFromThis< rogue::interfaces::stream::Master >
std::shared_ptr< rogue::interfaces::stream::Master >	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.

Public Member Functions inherited from rogue::interfaces::stream::Slave
	Slave ()
	Constructs a stream slave.

virtual	~Slave ()
	Destroys the stream slave.

virtual void	stop ()
	Shuts down threads associated with this object.

void	setDebug (uint32_t debug, std::string name)
	Sets debug message verbosity and logger name.

uint64_t	getFrameCount ()
	Returns frame counter.

uint64_t	getByteCount ()
	Returns byte counter.

bool	ensureSingleBuffer (std::shared_ptr< rogue::interfaces::stream::Frame > &frame, bool reqEn)
	Ensures frame is backed by a single buffer.

std::shared_ptr< rogue::interfaces::stream::Frame >	reqLocalFrame (uint32_t size, bool zeroCopyEn)
	Services a local frame allocation request through this object's pool interface.

boost::python::object	lshiftPy (boost::python::object p)
	Supports `<<` operator usage from Python.

std::shared_ptr< rogue::interfaces::stream::Master > &	operator<< (std::shared_ptr< rogue::interfaces::stream::Master > &other)
	Connects this slave to a master via stream chaining operator.

Public Member Functions inherited from rogue::interfaces::stream::Pool
	Pool ()
	Constructs a pool with default allocation behavior enabled.

virtual	~Pool ()
	Destroys the pool and releases any cached buffer storage.

uint32_t	getAllocBytes ()
	Returns total currently allocated bytes.

uint32_t	getAllocCount ()
	Returns total currently allocated buffer count.

virtual void	retBuffer (uint8_t *data, uint32_t meta, uint32_t size)
	Returns buffer data to the allocator.

void	setFixedSize (uint32_t size)
	Sets fixed-size mode.

uint32_t	getFixedSize ()
	Returns fixed-size allocation setting.

void	setPoolSize (uint32_t size)
	Sets buffer pool size.

uint32_t	getPoolSize ()
	Returns configured maximum number of cached pool entries.

Public Member Functions inherited from rogue::EnableSharedFromThis< rogue::interfaces::stream::Pool >
std::shared_ptr< rogue::interfaces::stream::Pool >	shared_from_this ()
	Returns a `shared_ptr<T>` for this instance.

Public Member Functions inherited from rogue::EnableSharedFromThis< rogue::interfaces::stream::Slave >
std::shared_ptr< rogue::interfaces::stream::Slave >	shared_from_this ()
	Returns a `shared_ptr<T>` for this instance.

Static Public Member Functions
static std::shared_ptr< rogue::protocols::rssi::Application >	create ()
	Creates an RSSI application endpoint.

static void	setup_python ()
	Registers Python bindings for this class.

Static Public Member Functions inherited from rogue::interfaces::stream::Master
static std::shared_ptr< rogue::interfaces::stream::Master >	create ()
	Creates a stream master.

static void	setup_python ()
	Registers this type with Python bindings.

Static Public Member Functions inherited from rogue::interfaces::stream::Slave
static std::shared_ptr< rogue::interfaces::stream::Slave >	create ()
	Creates a new stream slave.

static void	setup_python ()
	Registers this type with Python bindings.

Static Public Member Functions inherited from rogue::interfaces::stream::Pool
static void	setup_python ()
	Registers this type with Python bindings.

Additional Inherited Members
Protected Member Functions inherited from rogue::interfaces::stream::Pool
std::shared_ptr< rogue::interfaces::stream::Buffer >	allocBuffer (uint32_t size, uint32_t *total)
	Allocate a buffer passed size.

std::shared_ptr< rogue::interfaces::stream::Buffer >	createBuffer (void *data, uint32_t meta, uint32_t size, uint32_t alloc)
	Creates a Buffer with a pre-allocated data block.

void	decCounter (uint32_t alloc)
	Decrements allocation counter.

Detailed Description

RSSI application-side endpoint.

Provides stream ingress/egress for payload traffic through the RSSI stack.

Threading model:

Inbound application frames are handled synchronously in acceptFrame() and forwarded to Controller::applicationRx().
Outbound application frames are produced by a background thread started in setController() and drained from Controller::applicationTx().

Lifetime contract:

setController() must be called before destruction so the TX thread is created and can be cleanly stopped/joined.

Definition at line 50 of file Application.h.

Constructor & Destructor Documentation

◆ Application()

rogue::protocols::rssi::Application::Application ( )

Constructs an RSSI application endpoint.

Creator.

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

Definition at line 57 of file Application.cpp.

◆ ~Application()

rogue::protocols::rssi::Application::~Application ( )

Destroys the application endpoint.

Destructor.

Definition at line 60 of file Application.cpp.

Member Function Documentation

◆ acceptFrame()

void rogue::protocols::rssi::Application::acceptFrame ( std::shared_ptr< rogue::interfaces::stream::Frame > frame )

virtual

Accepts a frame from upstream application logic.

Accept a frame from master.

Parameters

frame Input frame for RSSI transmission.

Reimplemented from rogue::interfaces::stream::Slave.

Definition at line 86 of file Application.cpp.

◆ acceptReq()

rogue::interfaces::stream::FramePtr rogue::protocols::rssi::Application::acceptReq	(	uint32_t	size,
		bool	zeroCopyEn
	)

virtual

Allocates a frame for upstream writers.

Generate a Frame. Called from master.

Called by the stream master side of this endpoint.

Parameters

size	Minimum requested payload size in bytes.
zeroCopyEn	Zero-copy hint (not used by RSSI application path).

Returns: Newly allocated frame.

Reimplemented from rogue::interfaces::stream::Pool.

Definition at line 81 of file Application.cpp.

◆ create()

rogue::protocols::rssi::ApplicationPtr rogue::protocols::rssi::Application::create ( )

static

Creates an RSSI application endpoint.

Class creation.

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.

Returns: Shared pointer to the created application endpoint.

Company : SLAC National Accelerator Laboratory

Description:

RSSI Application Port

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 Application.cpp.

◆ setController()

void rogue::protocols::rssi::Application::setController ( std::shared_ptr< rogue::protocols::rssi::Controller > cntl )

Attaches the RSSI controller.

Setup links.

Stores controller reference and starts outbound worker thread.

Parameters

cntl	Controller instance that owns protocol state.

Definition at line 67 of file Application.cpp.

◆ setup_python()

void rogue::protocols::rssi::Application::setup_python ( )

static

Registers Python bindings for this class.

Definition at line 44 of file Application.cpp.

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

/home/runner/work/rogue/rogue/include/rogue/protocols/rssi/Application.h
/home/runner/work/rogue/rogue/src/rogue/protocols/rssi/Application.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Application()

◆ ~Application()

Member Function Documentation

◆ acceptFrame()

◆ acceptReq()

◆ create()

Company : SLAC National Accelerator Laboratory

RSSI Application Port

contained in the LICENSE.txt file.

◆ setController()

◆ setup_python()