ControllerV1

TODO

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

typedef std::shared_ptr<rogue::protocols::packetizer::ControllerV1> rogue::protocols::packetizer::ControllerV1Ptr

The class description is shown below:

class ControllerV1 : public rogue::protocols::packetizer::Controller, public rogue::EnableSharedFromThis<rogue::protocols::packetizer::ControllerV1>

Packetizer controller implementation for protocol v1.

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

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

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.

~ControllerV1()

Destroys the controller instance.

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

Processes a frame received at the transport interface.

Parameters:

frame – Transport frame to decode and route.

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

Processes a frame received from one application endpoint.

Parameters:

  • frame – Application frame to packetize.

  • id – Application/destination identifier.

Public Static 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.

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.