Python-overridable wrapper for ZmqClient. More...

#include <ZmqClient.h>

Inheritance diagram for rogue::interfaces::ZmqClientWrap:

Public Member Functions
	ZmqClientWrap (const std::string &addr, uint16_t port, bool doString)
	Constructs wrapper client.

void	doUpdate (boost::python::object data)
	Handles an update message from the subscription path.

void	defDoUpdate (boost::python::object data)
	Calls base-class `doUpdate()` implementation.

Public Member Functions inherited from rogue::interfaces::ZmqClient
	ZmqClient (const std::string &addr, uint16_t port, bool doString)
	Constructs a ZeroMQ client and connects sockets.

virtual	~ZmqClient ()
	Destroys client and stops background activity.

void	setTimeout (uint32_t msecs, bool waitRetry)
	Sets request timeout behavior.

std::string	sendString (const std::string &path, const std::string &attr, const std::string &arg)
	Sends a string-mode request.

std::string	getDisp (const std::string &path)
	Reads display-formatted value at a path (string mode).

void	setDisp (const std::string &path, const std::string &value)
	Writes display-formatted value at a path (string mode).

std::string	exec (const std::string &path, const std::string &arg="")
	Executes callable node at path (string mode).

std::string	valueDisp (const std::string &path)
	Reads compact value display at a path (string mode).

boost::python::object	send (boost::python::object data)
	Sends binary request payload and receives binary response.

void	stop ()
	Stops client sockets and background thread.

Additional Inherited Members
Static Public Member Functions inherited from rogue::interfaces::ZmqClient
static std::shared_ptr< rogue::interfaces::ZmqClient >	create (const std::string &addr, uint16_t port, bool doString)
	Creates a ZeroMQ client.

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

Detailed Description

Python-overridable wrapper for ZmqClient.

Definition at line 184 of file ZmqClient.h.

Constructor & Destructor Documentation

rogue::interfaces::ZmqClientWrap::ZmqClientWrap	(	const std::string &	addr,
		uint16_t	port,
		bool	doString
	)

Constructs wrapper client.

Parameters

addr	Server bind address or host.
port	Base server port.
doString	`true` for string request mode, `false` for binary mode.

Definition at line 285 of file ZmqClient.cpp.

void rogue::interfaces::ZmqClientWrap::defDoUpdate ( boost::python::object data )

Calls base-class doUpdate() implementation.

Default Boost.Python fallback for _doUpdate() when no Python override is provided.

Parameters

data	Update payload as a Python object.

Definition at line 299 of file ZmqClient.cpp.

void rogue::interfaces::ZmqClientWrap::doUpdate ( boost::python::object data )

virtual

Handles an update message from the subscription path.

Invokes the overridden _doUpdate() Python method when present, then calls the base-class ZmqClient::doUpdate() implementation.

Parameters

data	Update payload as a Python object.

Definition at line 288 of file ZmqClient.cpp.

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