YARP  2.3.70.1
Yet Another Robot Platform
yarp::os::MultiNameSpace Class Reference

#include <yarp/os/MultiNameSpace.h>

+ Inheritance diagram for yarp::os::MultiNameSpace:

Public Member Functions

 MultiNameSpace ()
 
virtual ~MultiNameSpace ()
 
bool setLocalMode (bool flag)
 
bool activate (bool force=false)
 
virtual Contact getNameServerContact () const YARP_OVERRIDE
 Get an address for a name server that manages the name space, if available. More...
 
virtual Contact queryName (const ConstString &name) YARP_OVERRIDE
 Map from port name to contact information. More...
 
virtual Contact registerName (const ConstString &name) YARP_OVERRIDE
 Record contact information to tie to a port name. More...
 
virtual Contact registerContact (const Contact &contact) YARP_OVERRIDE
 Record contact information (should include a port name). More...
 
virtual Contact unregisterName (const ConstString &name) YARP_OVERRIDE
 Disassociate contact information from a port name. More...
 
virtual Contact unregisterContact (const Contact &contact) YARP_OVERRIDE
 Disassociate contact information (should include a port name). More...
 
virtual bool setProperty (const ConstString &name, const ConstString &key, const Value &value) YARP_OVERRIDE
 Associate a key/value pair with a named port. More...
 
virtual ValuegetProperty (const ConstString &name, const ConstString &key) YARP_OVERRIDE
 Get the value of a named key from a named port. More...
 
virtual bool connectPortToTopic (const Contact &src, const Contact &dest, ContactStyle style) YARP_OVERRIDE
 Publish a port to a topic. More...
 
virtual bool connectTopicToPort (const Contact &src, const Contact &dest, ContactStyle style) YARP_OVERRIDE
 Subscribe a port to a topic. More...
 
virtual bool disconnectPortFromTopic (const Contact &src, const Contact &dest, ContactStyle style) YARP_OVERRIDE
 Stop publishing a port to a topic. More...
 
virtual bool disconnectTopicFromPort (const Contact &src, const Contact &dest, ContactStyle style) YARP_OVERRIDE
 Stop subscribing a port to a topic. More...
 
virtual bool connectPortToPortPersistently (const Contact &src, const Contact &dest, ContactStyle style) YARP_OVERRIDE
 Connect two ports with persistence. More...
 
virtual bool disconnectPortToPortPersistently (const Contact &src, const Contact &dest, ContactStyle style) YARP_OVERRIDE
 Disconnect two ports, removing any persistence. More...
 
virtual bool localOnly () const YARP_OVERRIDE
 Check if the NameSpace is only valid for the current process ("local"). More...
 
virtual bool usesCentralServer () const YARP_OVERRIDE
 Check if a central server is involved in managing the NameSpace. More...
 
virtual bool serverAllocatesPortNumbers () const YARP_OVERRIDE
 Check if a central server is responsible for allocating port numbers, or if this should be left up to the operating system. More...
 
virtual bool connectionHasNameOfEndpoints () const YARP_OVERRIDE
 When connections are made involving ports managed by this NameSpace do the ports involved end up knowing the names of their counterparties? More...
 
virtual void queryBypass (NameStore *store)
 Set an alternative place to make name queries. More...
 
virtual NameStoregetQueryBypass ()
 Get any alternative place to make name queries, if one was set by queryBypass() More...
 
virtual Contact detectNameServer (bool useDetectedServer, bool &scanNeeded, bool &serverUsed) YARP_OVERRIDE
 Find a name server for this NameSpace, if applicable. More...
 
virtual bool writeToNameServer (PortWriter &cmd, PortReader &reply, const ContactStyle &style) YARP_OVERRIDE
 Write a message to a name server for this NameSpace, if applicable. More...
 
- Public Member Functions inherited from yarp::os::NameSpace
virtual ~NameSpace ()
 Destructor. More...
 
virtual bool checkNetwork ()
 Check if a name space is available. More...
 
virtual bool checkNetwork (double timeout)
 Check if a name space is available, with a timeout on any network operations needed. More...
 
virtual ConstString getNameServerName () const
 Get the port name of a name server that manages the name space, if available. More...
 
virtual Contact registerAdvanced (const Contact &contact, NameStore *store)
 Record contact information, with access to the contact information of other ports for cross-referencing. More...
 
virtual Contact unregisterAdvanced (const ConstString &name, NameStore *store)
 Remove contact information, with access to the contact information of other ports for cross-referencing. More...
 

Private Attributes

void * system_resource
 
NameStorealtStore
 

Detailed Description

Definition at line 19 of file MultiNameSpace.h.

Constructor & Destructor Documentation

◆ MultiNameSpace()

MultiNameSpace::MultiNameSpace ( )

Definition at line 198 of file MultiNameSpace.cpp.

◆ ~MultiNameSpace()

MultiNameSpace::~MultiNameSpace ( )
virtual

Definition at line 204 of file MultiNameSpace.cpp.

Member Function Documentation

◆ activate()

bool MultiNameSpace::activate ( bool  force = false)

Definition at line 243 of file MultiNameSpace.cpp.

◆ connectionHasNameOfEndpoints()

bool MultiNameSpace::connectionHasNameOfEndpoints ( ) const
virtual

When connections are made involving ports managed by this NameSpace do the ports involved end up knowing the names of their counterparties?

Implements yarp::os::NameSpace.

Definition at line 225 of file MultiNameSpace.cpp.

◆ connectPortToPortPersistently()

bool MultiNameSpace::connectPortToPortPersistently ( const Contact src,
const Contact dest,
ContactStyle  style 
)
virtual

Connect two ports with persistence.

Implements yarp::os::NameSpace.

Definition at line 287 of file MultiNameSpace.cpp.

◆ connectPortToTopic()

bool MultiNameSpace::connectPortToTopic ( const Contact src,
const Contact dest,
ContactStyle  style 
)
virtual

Publish a port to a topic.

Implements yarp::os::NameSpace.

Definition at line 255 of file MultiNameSpace.cpp.

◆ connectTopicToPort()

bool MultiNameSpace::connectTopicToPort ( const Contact src,
const Contact dest,
ContactStyle  style 
)
virtual

Subscribe a port to a topic.

Implements yarp::os::NameSpace.

Definition at line 263 of file MultiNameSpace.cpp.

◆ detectNameServer()

Contact MultiNameSpace::detectNameServer ( bool  useDetectedServer,
bool &  scanNeeded,
bool &  serverUsed 
)
virtual

Find a name server for this NameSpace, if applicable.

Parameters
useDetectedServeruse any server found for future queries.
scanNeededset to true if a search was needed, rather than finding a name server based on cached hints.
serverUsedset to true if a server was found and marked for use in future queries.

Implements yarp::os::NameSpace.

Definition at line 370 of file MultiNameSpace.cpp.

◆ disconnectPortFromTopic()

bool MultiNameSpace::disconnectPortFromTopic ( const Contact src,
const Contact dest,
ContactStyle  style 
)
virtual

Stop publishing a port to a topic.

Implements yarp::os::NameSpace.

Definition at line 271 of file MultiNameSpace.cpp.

◆ disconnectPortToPortPersistently()

bool MultiNameSpace::disconnectPortToPortPersistently ( const Contact src,
const Contact dest,
ContactStyle  style 
)
virtual

Disconnect two ports, removing any persistence.

Implements yarp::os::NameSpace.

Definition at line 295 of file MultiNameSpace.cpp.

◆ disconnectTopicFromPort()

bool MultiNameSpace::disconnectTopicFromPort ( const Contact src,
const Contact dest,
ContactStyle  style 
)
virtual

Stop subscribing a port to a topic.

Implements yarp::os::NameSpace.

Definition at line 279 of file MultiNameSpace.cpp.

◆ getNameServerContact()

Contact MultiNameSpace::getNameServerContact ( ) const
virtual

Get an address for a name server that manages the name space, if available.

Implements yarp::os::NameSpace.

Definition at line 247 of file MultiNameSpace.cpp.

◆ getProperty()

Value * MultiNameSpace::getProperty ( const ConstString name,
const ConstString key 
)
virtual

Get the value of a named key from a named port.

Returns
YARP_NULLPTR if no value was set for the named key.

Implements yarp::os::NameSpace.

Definition at line 364 of file MultiNameSpace.cpp.

◆ getQueryBypass()

NameStore * MultiNameSpace::getQueryBypass ( )
virtual

Get any alternative place to make name queries, if one was set by queryBypass()

Definition at line 234 of file MultiNameSpace.cpp.

◆ localOnly()

bool MultiNameSpace::localOnly ( ) const
virtual

Check if the NameSpace is only valid for the current process ("local").

Implements yarp::os::NameSpace.

Definition at line 215 of file MultiNameSpace.cpp.

◆ queryBypass()

void MultiNameSpace::queryBypass ( NameStore store)
virtual

Set an alternative place to make name queries.

This method is typically used when writing name servers in YARP, so you don't end up with a loop.

Definition at line 230 of file MultiNameSpace.cpp.

◆ queryName()

Contact MultiNameSpace::queryName ( const ConstString name)
virtual

Map from port name to contact information.

Implements yarp::os::NameSpace.

Definition at line 251 of file MultiNameSpace.cpp.

◆ registerContact()

Contact MultiNameSpace::registerContact ( const Contact contact)
virtual

Record contact information (should include a port name).

Implements yarp::os::NameSpace.

Definition at line 324 of file MultiNameSpace.cpp.

◆ registerName()

Contact MultiNameSpace::registerName ( const ConstString name)
virtual

Record contact information to tie to a port name.

Implements yarp::os::NameSpace.

Definition at line 303 of file MultiNameSpace.cpp.

◆ serverAllocatesPortNumbers()

bool MultiNameSpace::serverAllocatesPortNumbers ( ) const
virtual

Check if a central server is responsible for allocating port numbers, or if this should be left up to the operating system.

Implements yarp::os::NameSpace.

Definition at line 238 of file MultiNameSpace.cpp.

◆ setLocalMode()

bool MultiNameSpace::setLocalMode ( bool  flag)

Definition at line 211 of file MultiNameSpace.cpp.

◆ setProperty()

bool MultiNameSpace::setProperty ( const ConstString name,
const ConstString key,
const Value value 
)
virtual

Associate a key/value pair with a named port.

Implements yarp::os::NameSpace.

Definition at line 357 of file MultiNameSpace.cpp.

◆ unregisterContact()

Contact MultiNameSpace::unregisterContact ( const Contact contact)
virtual

Disassociate contact information (should include a port name).

Implements yarp::os::NameSpace.

Definition at line 346 of file MultiNameSpace.cpp.

◆ unregisterName()

Contact MultiNameSpace::unregisterName ( const ConstString name)
virtual

Disassociate contact information from a port name.

Implements yarp::os::NameSpace.

Definition at line 335 of file MultiNameSpace.cpp.

◆ usesCentralServer()

bool MultiNameSpace::usesCentralServer ( ) const
virtual

Check if a central server is involved in managing the NameSpace.

Implements yarp::os::NameSpace.

Definition at line 220 of file MultiNameSpace.cpp.

◆ writeToNameServer()

bool MultiNameSpace::writeToNameServer ( PortWriter cmd,
PortReader reply,
const ContactStyle style 
)
virtual

Write a message to a name server for this NameSpace, if applicable.

Messages are name-server-specific.

Implements yarp::os::NameSpace.

Definition at line 397 of file MultiNameSpace.cpp.

Member Data Documentation

◆ altStore

NameStore* yarp::os::MultiNameSpace::altStore
private

Definition at line 105 of file MultiNameSpace.h.

◆ system_resource

void* yarp::os::MultiNameSpace::system_resource
private

Definition at line 104 of file MultiNameSpace.h.


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