Client for YARP name server. More...

#include <yarp/os/impl/NameClient.h>

Public Member Functions
virtual	~NameClient ()
	Destructor.

Contact	getAddress ()
	The address of the name server.

Contact	queryName (const std::string &name)
	Look up the address of a named port.

Contact	registerName (const std::string &name)
	Register a port with a given name.

Contact	registerName (const std::string &name, const Contact &suggest)
	Register a port with a given name and a partial address.

Contact	unregisterName (const std::string &name)
	Register disassociation of name from port.

Contact	probe (const std::string &cmd)
	Send a message to the name server, and interpret the result as an address.

std::string	send (const std::string &cmd, bool multi=true, const ContactStyle &style=ContactStyle())
	Send a text message to the nameserver, and return the result.

bool	send (yarp::os::Bottle &cmd, yarp::os::Bottle &reply)
	Send a message to the nameserver in Bottle format, and return the result.

void	setFakeMode (bool fake=true)
	For testing, the nameclient can be set to use a "fake" name server rather than communicating with an external name server.

bool	isFakeMode () const
	Check whether a fake name server is being used.

void	setScan (bool allow=true)
	Control whether the name client should scan for the name server if the cached connection information for it is inaccurate.

void	setSave (bool allow=true)
	Control whether the name client can save the address of the name server in a cache file.

bool	didScan ()
	Check whether the name client scanned for the address of the name server.

bool	didSave ()
	Check whether the name client saved the address of the name server.

bool	updateAddress ()
	Force the name client to reread the cached location of the name server.

bool	setContact (const yarp::os::Contact &contact)

void	queryBypass (NameStore *store)

NameStore *	getQueryBypass ()

std::string	getMode ()

yarp::os::Nodes &	getNodes ()

Static Public Member Functions
static NameClient &	getNameClient ()
	Get an instance of the name client.

static NameClient *	create ()

static Contact	extractAddress (const std::string &txt)
	Extract an address from its text representation.

static Contact	extractAddress (const Bottle &bot)

Detailed Description

Client for YARP name server.

There is one global client available from the getNameClient method. The protocol spoken by the name client is rather old; there are simpler ways of talking to the name server these days - it is now a regular port, that can read and respond to messages in the bottle format.

Definition at line 32 of file NameClient.h.

Constructor & Destructor Documentation

◆ ~NameClient()

NameClient::~NameClient ( )

virtual

Destructor.

Definition at line 117 of file NameClient.cpp.

Member Function Documentation

◆ create()

NameClient * NameClient::create ( )

static

Definition at line 131 of file NameClient.cpp.

◆ didSave()

bool NameClient::didSave ( )

Check whether the name client saved the address of the name server.

Returns: true iff the name client saved the address of the name server.

Definition at line 454 of file NameClient.cpp.

◆ didScan()

bool NameClient::didScan ( )

Check whether the name client scanned for the address of the name server.

Returns: true iff the name client scanned for the name server.

Definition at line 449 of file NameClient.cpp.

◆ extractAddress() [1/2]

Contact NameClient::extractAddress ( const Bottle & bot )

static

Definition at line 286 of file NameClient.cpp.

◆ extractAddress() [2/2]

Contact NameClient::extractAddress ( const std::string & txt )

static

Extract an address from its text representation.

Parameters

txt	the text representation of an address

Returns: the address corresponding to the text representation

Definition at line 270 of file NameClient.cpp.

◆ getAddress()

Contact NameClient::getAddress ( )

The address of the name server.

Returns: the address of the name server

Definition at line 137 of file NameClient.cpp.

◆ getMode()

std::string NameClient::getMode ( )

Definition at line 493 of file NameClient.cpp.

◆ getNameClient()

NameClient & NameClient::getNameClient ( )

static

Get an instance of the name client.

This is a global singleton, created on demand.

Returns: the name client

Definition at line 125 of file NameClient.cpp.

◆ getNodes()

yarp::os::Nodes & NameClient::getNodes ( )

Definition at line 498 of file NameClient.cpp.

◆ getQueryBypass()

NameStore * NameClient::getQueryBypass ( )

Definition at line 488 of file NameClient.cpp.

◆ isFakeMode()

bool NameClient::isFakeMode ( ) const

Check whether a fake name server is being used.

Returns: true iff a fake name server is being used.

Definition at line 434 of file NameClient.cpp.

◆ probe()

Contact NameClient::probe ( const std::string & cmd )

Send a message to the name server, and interpret the result as an address.

Parameters

cmd	the message to send (in text form)

Returns: the address extracted from the reply, all errors result in a non-valid address.

Definition at line 264 of file NameClient.cpp.

◆ queryBypass()

void NameClient::queryBypass ( NameStore * store )

Definition at line 483 of file NameClient.cpp.

◆ queryName()

Contact NameClient::queryName ( const std::string & name )

Look up the address of a named port.

Parameters

name	the name of the port

Returns: the address associated with the port

Definition at line 143 of file NameClient.cpp.

◆ registerName() [1/2]

Contact NameClient::registerName ( const std::string & name )

Register a port with a given name.

Parameters

name	the name of the port

Returns: the address associated with the port

Definition at line 163 of file NameClient.cpp.

◆ registerName() [2/2]

Contact NameClient::registerName	(	const std::string &	name,
		const Contact &	suggest
	)

Register a port with a given name and a partial address.

Parameters

name	the name of the port
suggest	a partially completed address

Returns: the address associated with the port

Definition at line 168 of file NameClient.cpp.

◆ send() [1/2]

std::string NameClient::send	(	const std::string &	cmd,
		bool	multi = `true`,
		const ContactStyle &	style = `ContactStyle()`
	)

Send a text message to the nameserver, and return the result.

Parameters

cmd	the message to send.
multi	whether to expect a multi-line response.

Returns: the reply from the name server.

Definition at line 299 of file NameClient.cpp.

◆ send() [2/2]

bool NameClient::send	(	yarp::os::Bottle &	cmd,
		yarp::os::Bottle &	reply
	)

Send a message to the nameserver in Bottle format, and return the result.

Parameters

[in]	cmd	the message to send.
[out]	the	reply from the name server.

Returns: true on success.

Definition at line 411 of file NameClient.cpp.

◆ setContact()

bool NameClient::setContact ( const yarp::os::Contact & contact )

Definition at line 472 of file NameClient.cpp.

◆ setFakeMode()

void NameClient::setFakeMode ( bool fake = true )

For testing, the nameclient can be set to use a "fake" name server rather than communicating with an external name server.

Parameters

fake	whether to use a fake name server

Definition at line 429 of file NameClient.cpp.

◆ setSave()

void NameClient::setSave ( bool allow = true )

Control whether the name client can save the address of the name server in a cache file.

Parameters

allow true if the name client may save the name server address.

Definition at line 444 of file NameClient.cpp.

◆ setScan()

void NameClient::setScan ( bool allow = true )

Control whether the name client should scan for the name server if the cached connection information for it is inaccurate.

Parameters

allow true if the name client may scan for the name server.

Definition at line 439 of file NameClient.cpp.

◆ unregisterName()

Contact NameClient::unregisterName ( const std::string & name )

Register disassociation of name from port.

Parameters

name	the name to remove

Returns: the new result of queries for that name (should be empty)

Definition at line 257 of file NameClient.cpp.

◆ updateAddress()

bool NameClient::updateAddress ( )

Force the name client to reread the cached location of the name server.

Returns: true if the address for the name server was found.

Definition at line 459 of file NameClient.cpp.

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

src/libYARP_os/src/yarp/os/impl/NameClient.h
src/libYARP_os/src/yarp/os/impl/NameClient.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~NameClient()

Member Function Documentation

◆ create()

◆ didSave()

◆ didScan()

◆ extractAddress() [1/2]

◆ extractAddress() [2/2]

◆ getAddress()

◆ getMode()

◆ getNameClient()

◆ getNodes()

◆ getQueryBypass()

◆ isFakeMode()

◆ probe()

◆ queryBypass()

◆ queryName()

◆ registerName() [1/2]

◆ registerName() [2/2]

◆ send() [1/2]

◆ send() [2/2]

◆ setContact()

◆ setFakeMode()

◆ setSave()

◆ setScan()

◆ unregisterName()

◆ updateAddress()