Transport
TODO
Transport objects in C++ are referenced by the following shared pointer typedef:
-
typedef std::shared_ptr<rogue::protocols::packetizer::Transport> rogue::protocols::packetizer::TransportPtr
The class description is shown below:
-
class Transport : public rogue::interfaces::stream::Master, public rogue::interfaces::stream::Slave
Packetizer transport endpoint.
Bridges raw stream traffic to/from the packetizer controller.
Threading model:
Inbound frames are handled synchronously by
acceptFrame(), which forwards each frame toController::transportRx().Outbound frames are produced by a dedicated background thread started in
setController(). That thread drainsController::transportTx()and forwards returned frames viasendFrame().
Lifetime contract:
setController()must be called before destruction so the TX queue thread can be started/stopped against a valid controller.
Public Functions
-
Transport()
Constructs a packetizer transport endpoint.
This constructor is a low-level C++ allocation path. Prefer
create()when shared ownership or Python exposure is required.
-
~Transport()
Destroys the packetizer transport endpoint.
Attaches the packetizer controller.
Stores the controller reference and starts the outbound worker thread that forwards controller-generated transport frames.
- Parameters:
cntl – Controller instance that handles packetizer protocol processing.
Accepts a frame from the upstream stream interface.
- Parameters:
frame – Input frame to decode and forward to controller logic.
Public Static Functions
-
static std::shared_ptr<rogue::protocols::packetizer::Transport> create()
Creates a packetizer transport endpoint.
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_ptrownership compatible with Rogue pointer typedefs.- Returns:
Shared pointer to the created transport endpoint.
-
static void setup_python()
Registers Python bindings for this class.