Stream TCP bridge client. More...

#include <TcpClient.h>

Inheritance diagram for rogue::interfaces::stream::TcpClient:

Public Member Functions
	TcpClient (std::string addr, uint16_t port)
	Constructs a TCP stream bridge client.

	~TcpClient ()
	Destroys the TCP client.

Public Member Functions inherited from rogue::interfaces::stream::TcpCore
	TcpCore (const std::string &addr, uint16_t port, bool server)
	Constructs a TCP stream bridge core.

	~TcpCore ()
	Destroys the bridge core and releases resources.

void	close ()
	Closes active bridge connections.

void	stop ()
	Stops the interface and worker thread.

void	acceptFrame (std::shared_ptr< rogue::interfaces::stream::Frame > frame)
	Receives a frame from upstream and forwards over the TCP bridge.

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.

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.

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 std::shared_ptr< rogue::interfaces::stream::Frame >	acceptReq (uint32_t size, bool zeroCopyEn)
	Services a frame allocation request from a master.

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::interfaces::stream::TcpClient >	create (std::string addr, uint16_t port)
	Creates a TCP stream bridge client and return as TcpClientPtr.

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

Static Public Member Functions inherited from rogue::interfaces::stream::TcpCore
static std::shared_ptr< rogue::interfaces::stream::TcpCore >	create (const std::string &addr, uint16_t port, bool server)
	Creates a TCP stream bridge core instance and returns it as `TcpCorePtr`.

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.

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::TcpCore
void	runThread ()
	Run thread.

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.

Protected Attributes inherited from rogue::interfaces::stream::TcpCore
std::string	pullAddr_

std::string	pushAddr_

void *	zmqCtx_

void *	zmqPull_

void *	zmqPush_

std::shared_ptr< rogue::Logging >	bridgeLog_

std::thread *	thread_

bool	threadEn_

std::mutex	bridgeMtx_

Detailed Description

Stream TCP bridge client.

Thin wrapper around TcpCore configured for client mode.

Definition at line 42 of file TcpClient.h.

Constructor & Destructor Documentation

◆ TcpClient()

rogue::interfaces::stream::TcpClient::TcpClient	(	std::string	addr,
		uint16_t	port
	)

Constructs a TCP stream bridge client.

Creator.

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

The constructor takes an address and port. The remote server address can be an IP address or hostname. The bridge uses two consecutive TCP ports; port is the base (for example, port=8000 uses 8000 and 8001).

Parameters

addr	Remote server address.
port	Base TCP port number.

Definition at line 48 of file TcpClient.cpp.

◆ ~TcpClient()

rogue::interfaces::stream::TcpClient::~TcpClient ( )

Destroys the TCP client.

Destructor.

Definition at line 51 of file TcpClient.cpp.

Member Function Documentation

◆ create()

rogue::interfaces::stream::TcpClientPtr rogue::interfaces::stream::TcpClient::create	(	std::string	addr,
		uint16_t	port
	)

static

Creates a TCP stream bridge client and return as TcpClientPtr.

Class creation.

Parameter semantics are identical to the constructor; see TcpClient() for address and port behavior details. Exposed in Python as rogue.interfaces.stream.TcpClient. 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

addr	Remote server address.
port	Base TCP port number.

Returns: Shared pointer to the created client.

Company : SLAC National Accelerator Laboratory

Description:

Stream Network Client

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 42 of file TcpClient.cpp.

◆ setup_python()

void rogue::interfaces::stream::TcpClient::setup_python ( )

static

Registers this type with Python bindings.

Definition at line 53 of file TcpClient.cpp.

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

/home/runner/work/rogue/rogue/include/rogue/interfaces/stream/TcpClient.h
/home/runner/work/rogue/rogue/src/rogue/interfaces/stream/TcpClient.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members