StreamZip

The StreamZip class provides a payload compression engine for Rogue Frames. This module will receive Frames from an external master, compress the Frame payload and then pass the compressed frame to a downstream Slave.

This compression module uses the Bzip2 library.

StreamZip objects in C++ are referenced by the following shared pointer typedef:

typedef std::shared_ptr<rogue::utilities::StreamZip> rogue::utilities::StreamZipPtr

The class description is shown below:

class StreamZip : public rogue::interfaces::stream::Slave, public rogue::interfaces::stream::Master

Stream compressor.

Public Functions

StreamZip()

Creator.

~StreamZip()

Deconstructor.

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

Accept a frame from master.

virtual std::shared_ptr<rogue::interfaces::stream::Frame> acceptReq(uint32_t size, bool zeroCopyEn)

Accept a new frame request.

Public Static Functions

static std::shared_ptr<rogue::utilities::StreamZip> create()

Class creation.

static void setup_python()

Setup class in python.