Pothos::RemoteClient Class Reference

#include <Client.hpp>

Inheritance diagram for Pothos::RemoteClient:

Public Member Functions
	RemoteClient (void)
	Make an empty handle. More...
	RemoteClient (const std::string &uri, const long timeoutUs=100000)
const std::string &	getUri (void) const
	Get the connection's URI. More...
	operator bool (void) const
	Is this remote client connected? More...
std::iostream &	getIoStream (void) const
ProxyEnvironment::Sptr	makeEnvironment (const std::string &name, const ProxyEnvironmentArgs &args=ProxyEnvironmentArgs())
Public Member Functions inherited from Pothos::Util::RefHolder
virtual	~RefHolder (void)
	Virtual destructor for derived classes. More...
void	holdRef (const Object &container)
	Store a copy of this object container. More...
void	dropRef (const Object &container)
	Drop a copy of this object container. More...

Static Public Member Functions
static ProxyEnvironment::Sptr	makeEnvironment (std::istream &is, std::ostream &os, const std::string &name, const ProxyEnvironmentArgs &args=ProxyEnvironmentArgs())
static ProxyEnvironment::Sptr	makeEnvironment (std::iostream &io, const std::string &name, const ProxyEnvironmentArgs &args=ProxyEnvironmentArgs())
static std::string	lookupIpFromNodeId (const std::string nodeId)

Detailed Description

A remote client is a handle for a client socket. The socket can be interacted with through iostream.

Constructor & Destructor Documentation

RemoteClient() [1/2]

Pothos::RemoteClient::RemoteClient

(

void

)

Make an empty handle.

RemoteClient() [2/2]

Pothos::RemoteClient::RemoteClient	(	const std::string &	uri,
		const long	timeoutUs = 100000
	)

Make a client handle to interact with a remote server. A unspecified port means use the default locator port. URI format: tcp://resolvable_hostname:optional_port

Parameters

uri	a formatted string which specifies a server
timeoutUs	the timeout to connect in microseconds

Member Function Documentation

getIoStream()

std::iostream& Pothos::RemoteClient::getIoStream

(

void

)

const

Get the iostream to interact with the client handle. This iostream can be passed to makeEnvironment to create a remote proxy.

getUri()

const std::string& Pothos::RemoteClient::getUri

(

void

)

const

Get the connection's URI.

lookupIpFromNodeId()

static std::string Pothos::RemoteClient::lookupIpFromNodeId ( const std::string  nodeId )

static

Lookup an IP address given the node identifier of the remote host.

See also

Pothos::ProxyEnvironment::getNodeId()

Parameters

nodeId

the unique ID of a host on the network

Returns

the IP address as a string or empty if lookup fails

makeEnvironment() [1/3]

ProxyEnvironment::Sptr Pothos::RemoteClient::makeEnvironment	(	const std::string &	name,
		const ProxyEnvironmentArgs &	args = ProxyEnvironmentArgs()
	)

Create a proxy environment that is interfaced through this remote client object.

makeEnvironment() [2/3]

static ProxyEnvironment::Sptr Pothos::RemoteClient::makeEnvironment ( std::istream &  is, std::ostream &  os, const std::string &  name, const ProxyEnvironmentArgs &  args = ProxyEnvironmentArgs()  )

static

Create a proxy environment that is interfaced over an iostream. This allows for remote proxies that talk over pipes and sockets.

makeEnvironment() [3/3]

static ProxyEnvironment::Sptr Pothos::RemoteClient::makeEnvironment ( std::iostream &  io, const std::string &  name, const ProxyEnvironmentArgs &  args = ProxyEnvironmentArgs()  )

static

Create a proxy environment that is interfaced over an iostream. This allows for remote proxies that talk over pipes and sockets.

operator bool()

Pothos::RemoteClient::operator bool ( void  ) const

explicit

Is this remote client connected?

---

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

• include/Pothos/Remote/Client.hpp