Stream module that compresses frame payloads using bzip2. More...

#include <StreamZip.h>

Inheritance diagram for rogue::utilities::StreamZip:

Public Member Functions
	StreamZip ()
	Constructs a stream compressor.

	~StreamZip ()
	Destroys stream compressor.

void	acceptFrame (std::shared_ptr< rogue::interfaces::stream::Frame > frame)
	Accepts a frame, compresses its payload, and forwards the result.

std::shared_ptr< rogue::interfaces::stream::Frame >	acceptReq (uint32_t size, bool zeroCopyEn)
	Forwards frame-allocation requests upstream.

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::EnableSharedFromThisBase
virtual	~EnableSharedFromThisBase ()
	Virtual destructor for polymorphic base usage.

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.

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.

Static Public Member Functions
static std::shared_ptr< rogue::utilities::StreamZip >	create ()
	Creates a stream compressor instance.

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

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.

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.

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

Stream module that compresses frame payloads using bzip2.

StreamZip consumes frames on its slave side, compresses the payload bytes, and forwards a new frame downstream from its master side. Frame metadata (channel, flags, error state) is preserved.

Output frame allocation is requested via reqFrame(). The implementation starts with an output frame sized to the input payload and grows it if needed.

Threading model:

StreamZip does not create an internal worker thread.
Compression runs synchronously in the caller thread that invokes acceptFrame().
A lock is taken on the input frame while payload buffers are read, so the frame contents are stable during compression.

Definition at line 49 of file StreamZip.h.

Constructor & Destructor Documentation

◆ StreamZip()

rogue::utilities::StreamZip::StreamZip ( )

Constructs a stream compressor.

Creator with width and variable taps.

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

Definition at line 51 of file StreamZip.cpp.

◆ ~StreamZip()

rogue::utilities::StreamZip::~StreamZip ( )

Destroys stream compressor.

Deconstructor.

Definition at line 54 of file StreamZip.cpp.

Member Function Documentation

◆ acceptFrame()

void rogue::utilities::StreamZip::acceptFrame ( std::shared_ptr< rogue::interfaces::stream::Frame > frame )

virtual

Accepts a frame, compresses its payload, and forwards the result.

Accept a frame from master.

Parameters

frame Input frame to compress.

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

Definition at line 57 of file StreamZip.cpp.

◆ acceptReq()

rogue::interfaces::stream::FramePtr rogue::utilities::StreamZip::acceptReq	(	uint32_t	size,
		bool	zeroCopyEn
	)

virtual

Forwards frame-allocation requests upstream.

Accept a new frame request. Forward request.

Parameters

size	Requested payload size in bytes.
zeroCopyEn	`true` to request zero-copy buffer handling.

Returns: Allocated frame from upstream master path.

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

Definition at line 129 of file StreamZip.cpp.

◆ create()

rogue::utilities::StreamZipPtr rogue::utilities::StreamZip::create ( )

static

Creates a stream compressor instance.

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 compressor.

Company : SLAC National Accelerator Laboratory

Description :

Stream modules to compress a data stream

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 45 of file StreamZip.cpp.

◆ setup_python()

void rogue::utilities::StreamZip::setup_python ( )

static

Registers Python bindings for this class.

Definition at line 133 of file StreamZip.cpp.

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

/home/runner/work/rogue/rogue/include/rogue/utilities/StreamZip.h
/home/runner/work/rogue/rogue/src/rogue/utilities/StreamZip.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members