From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/class_NLNET__CNamingClient.html | 977 +++++++++++++++++++++++ 1 file changed, 977 insertions(+) create mode 100644 docs/doxygen/nel/class_NLNET__CNamingClient.html (limited to 'docs/doxygen/nel/class_NLNET__CNamingClient.html') diff --git a/docs/doxygen/nel/class_NLNET__CNamingClient.html b/docs/doxygen/nel/class_NLNET__CNamingClient.html new file mode 100644 index 00000000..5be28c41 --- /dev/null +++ b/docs/doxygen/nel/class_NLNET__CNamingClient.html @@ -0,0 +1,977 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NLNET::CNamingClient Class Reference

Client side of Naming Service. +More... +

+#include <naming_client.h> +

+Collaboration diagram for NLNET::CNamingClient:

+ + + + + + + + + + + + + + + + + +[legend]List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Static Public Methods
void	connect (const CInetAddress& addr)
	Connect to the naming service. More...
bool	connected ()
	Return true if the connection to the Naming Service was done. More...
void	disconnect ()
	Close the connection to the naming service. More...
TServiceId	registerService (const std::string &name, const CInetAddress &addr)
	Register a service within the naming service. More...
bool	registerServiceWithSId (const std::string &name, const CInetAddress &addr, TServiceId sid)
	Register a service within the naming service, using a specified service identifier. More...
void	unregisterService (TServiceId sid)
	Unregister a service from the naming service, service identifier. More...
void	unregisterAllServices ()
	Unregister all services registered by this client. You don't have to. More...
uint16	queryServicePort ()
	Requests the naming service to choose a port for the service. More...
bool	lookup (const std::string &name, CInetAddress &addr)
	Returns true and the address of the specified service if it is found, otherwise returns false. More...
bool	lookup (TServiceId sid, CInetAddress &addr)
	Same as lookup(const string&, CInetAddress&, uint16&). More...
bool	lookupAlternate (const std::string& name, CInetAddress& addr)
	Tells the Naming Service the specified address does not respond for the specified service, and returns true and another address for the service if available, otherwise returns false. More...
void	lookupAll (const std::string &name, std::vector<CInetAddress> &addresses)
	Returns all services corresponding to the specified short name. More...
bool	lookupAndConnect (const std::string &name, CCallbackClient &sock)
	Obtains a socket connected to a service providing the service name. More...
void	update ()
	Call it evenly. More...
void	setRegistrationBroadcastCallback (TBroadcastCallback cb)
	You can link a callback if you want to know when a new service is registered (NULL to disable callback). More...
void	setUnregistrationBroadcastCallback (TBroadcastCallback cb)
	You can link a callback if you want to know when a new service is unregistered (NULL to disable callback). More...
Private Types
typedef std::map<TServiceId, + std::string>	TRegServices
	Type of map of registered services. More...
Private Methods
	CNamingClient ()
	Constructor. More...
	~CNamingClient ()
	Destructor. More...
Static Private Methods
void	doReceiveLookupAnswer (const std::string &name, std::vector<CInetAddress> &addrs)
Static Private Attributes
CCallbackClient*	_Connection = NULL
TRegServices	_RegisteredServices

Detailed Description

+Client side of Naming Service. +

+Allows to register/unregister services, and to lookup for a registered service. +

+Author(s):: + Olivier Cado , Vianney Lecroart , Nevrax France

+Date:: + 2001

+ +

+Definition at line 55 of file naming_client.h.

Member Typedef Documentation

+ + + + +
+ + + + + +
+typedef std::map<TServiceId, std::string> NLNET::CNamingClient::TRegServices [private] +
+
+ + + + + +
+ + + +
+Type of map of registered services. +
+ +
+Definition at line 152 of file naming_client.h.
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + +
+NLNET::CNamingClient::CNamingClient ( + +) [inline, private] +
+
+ + + + + +
+ + + +
+Constructor. +
+ +
+Definition at line 157 of file naming_client.h.
+

+ + + + +
+ + + + + + +
+NLNET::CNamingClient::~CNamingClient ( + +) [inline, private] +
+
+ + + + + +
+ + + +
+Destructor. +
+ +
+Definition at line 160 of file naming_client.h.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+void NLNET::CNamingClient::connect ( + +const CInetAddress & addr ) [static] +
+
+ + + + + +
+ + + +
+Connect to the naming service. +
+ +
+Definition at line 151 of file naming_client.cpp.
+

+ + + + +
+ + + + + + +
+bool NLNET::CNamingClient::connected ( + +) [inline, static] +
+
+ + + + + +
+ + + +
+Return true if the connection to the Naming Service was done. +
+ +
+Definition at line 64 of file naming_client.h.
+

+ + + + +
+ + + + + + +
+void NLNET::CNamingClient::disconnect ( + +) [static] +
+
+ + + + + +
+ + + +
+Close the connection to the naming service. +
+ +
+Definition at line 165 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + +
+void NLNET::CNamingClient::doReceiveLookupAnswer ( + +const std::string & name, +
+std::vector< CInetAddress >& addrs ) [static, private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 301 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + +
+bool NLNET::CNamingClient::lookup ( + +TServiceId sid, +
+CInetAddress & addr ) [static] +
+
+ + + + + +
+ + + +
+Same as lookup(const string&, CInetAddress&, uint16&). +
+ +
+Definition at line 342 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + +
+bool NLNET::CNamingClient::lookup ( + +const std::string & name, +
+CInetAddress & addr ) [static] +
+
+ + + + + +
+ + + +
+Returns true and the address of the specified service if it is found, otherwise returns false. +
+
+Parameters:
+ + + + +
name + + [in] Short name of the service to find
addr + + [out] Address of the service
validitytime + + [out] After this number of seconds are elapsed, another lookup will be necessary before sending a message to the service
+
+Returns:
+ true if all worked fine
+
+Definition at line 320 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + +
+void NLNET::CNamingClient::lookupAll ( + +const std::string & name, +
+std::vector< CInetAddress >& addrs ) [static] +
+
+ + + + + +
+ + + +
+Returns all services corresponding to the specified short name. +
+Ex: lookupAll ("AS", addresses); +
+Definition at line 384 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + +
+bool NLNET::CNamingClient::lookupAlternate ( + +const std::string & name, +
+CInetAddress & addr ) [static] +
+
+ + + + + +
+ + + +
+Tells the Naming Service the specified address does not respond for the specified service, and returns true and another address for the service if available, otherwise returns false. +
+
+Parameters:
+ + + + +
name + + [in] Short name of the service to find
addr + + [in/out] In: Address of the service that does not respond. Out: Alternative address
validitytime + + [out] After this number of seconds are elapsed, another lookup will be necessary before sending a message to the service
+
+Returns:
+ true if all worked fine.
+
+Definition at line 363 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + +
+bool NLNET::CNamingClient::lookupAndConnect ( + +const std::string & name, +
+CCallbackClient & sock ) [static] +
+
+ + + + + +
+ + + +
+Obtains a socket connected to a service providing the service name. +
+In case of failure to connect, the method informs the Naming Service and tries to get another service.
+Parameters:
+ + + + +
name + + [in] Short name of the service to find and connected
sock + + [out] The connected socket.
validitytime + + [out] After this number of seconds are elapsed, another lookup will be necessary before sending a message to the service.
+
+Returns:
+ false if the service was not found.
+
+Definition at line 397 of file naming_client.cpp.
+

+ + + + +
+ + + + + + +
+uint16 NLNET::CNamingClient::queryServicePort ( + +) [static] +
+
+ + + + + +
+ + + +
+Requests the naming service to choose a port for the service. +
+
+Returns:
+ An empty port number
+
+Definition at line 281 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + +
+TServiceId NLNET::CNamingClient::registerService ( + +const std::string & name, +
+const CInetAddress & addr ) [static] +
+
+ + + + + +
+ + + +
+Register a service within the naming service. +
+Returns the service identifier assigned by the NS (or 0 if it failed) +
+Definition at line 177 of file naming_client.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+bool NLNET::CNamingClient::registerServiceWithSId ( + +const std::string & name, +
+const CInetAddress & addr, +
+TServiceId sid ) [static] +
+
+ + + + + +
+ + + +
+Register a service within the naming service, using a specified service identifier. +
+Returns false if the service identifier is unavailable i.e. the registration failed. +
+Definition at line 206 of file naming_client.cpp.
+

+ + + + +
+ + + + + + +
+void NLNET::CNamingClient::setRegistrationBroadcastCallback ( + +TBroadcastCallback cb ) [static] +
+
+ + + + + +
+ + + +
+You can link a callback if you want to know when a new service is registered (NULL to disable callback). +
+ +
+Definition at line 48 of file naming_client.cpp.
+

+ + + + +
+ + + + + + +
+void NLNET::CNamingClient::setUnregistrationBroadcastCallback ( + +TBroadcastCallback cb ) [static] +
+
+ + + + + +
+ + + +
+You can link a callback if you want to know when a new service is unregistered (NULL to disable callback). +
+ +
+Definition at line 53 of file naming_client.cpp.
+

+ + + + +
+ + + + + + +
+void NLNET::CNamingClient::unregisterAllServices ( + +) [static] +
+
+ + + + + +
+ + + +
+Unregister all services registered by this client. You don't have to. +
+ +
+Definition at line 269 of file naming_client.cpp.
+

+ + + + +
+ + + + + + +
+void NLNET::CNamingClient::unregisterService ( + +TServiceId sid ) [static] +
+
+ + + + + +
+ + + +
+Unregister a service from the naming service, service identifier. +
+ +
+Definition at line 257 of file naming_client.cpp.
+

+ + + + +
+ + + + + + +
+void NLNET::CNamingClient::update ( + +) [static] +
+
+ + + + + +
+ + + +
+Call it evenly. +
+ +
+Definition at line 432 of file naming_client.cpp.
+

Member Data Documentation

+ + + + +
+ + + + + +
+CCallbackClient * NLNET::CNamingClient::_Connection = NULL [static, private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 41 of file naming_client.cpp.
+

+ + + + +
+ + + + + +
+CNamingClient::TRegServices NLNET::CNamingClient::_RegisteredServices [static, private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 42 of file naming_client.cpp.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLNET::CNamingClient Class Reference

Static Public Methods

Private Types

Private Methods

Static Private Methods

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation