This project has retired. For details please refer to its Attic page.
Apache REEF: Org.Apache.REEF.Network.Naming.NameClient Class Reference
Apache REEF  0.15.0
Retainable Evaluator Execution Framework
Classes | Public Member Functions | List of all members
Org.Apache.REEF.Network.Naming.NameClient Class Reference

Client for the Reef name service. More...

Inherits Org.Apache.REEF.Common.Io.INameClient.

Public Member Functions

void Register (string id, IPEndPoint endpoint)
 Synchronously registers the identifier with the NameService. More...
 
void Unregister (string id)
 Synchronously unregisters the remote identifier with the NameService More...
 
IPEndPoint CacheLookup (string id)
 Synchronously looks up the IPEndpoint for the registered identifier. More...
 
IPEndPoint Lookup (string id)
 Synchronously looks up the IPEndpoint for the registered identifier. More...
 
List< NameAssignmentLookup (List< string > ids)
 Synchronously looks up the IPEndpoint for each of the registered identifiers in the list. More...
 
void Restart (IPEndPoint serverEndpoint)
 Restart the name client in case of failure. More...
 
void Dispose ()
 Releases resources used by NameClient More...
 

Detailed Description

Client for the Reef name service.

Used to register, unregister, and lookup IP Addresses of known hosts.

Member Function Documentation

IPEndPoint Org.Apache.REEF.Network.Naming.NameClient.CacheLookup ( string  id)
inline

Synchronously looks up the IPEndpoint for the registered identifier.

Uses cache if it has entry

Parameters
idThe identifier to look up
Returns
The mapped IPEndpoint for the identifier, or null if the identifier has not been registered with the NameService

Implements Org.Apache.REEF.Common.Io.INameClient.

void Org.Apache.REEF.Network.Naming.NameClient.Dispose ( )
inline

Releases resources used by NameClient

IPEndPoint Org.Apache.REEF.Network.Naming.NameClient.Lookup ( string  id)
inline

Synchronously looks up the IPEndpoint for the registered identifier.

Does not use cache

Parameters
idThe identifier to look up
Returns
The mapped IPEndpoint for the identifier, or null if the identifier has not been registered with the NameService

Implements Org.Apache.REEF.Common.Io.INameClient.

List<NameAssignment> Org.Apache.REEF.Network.Naming.NameClient.Lookup ( List< string >  ids)
inline

Synchronously looks up the IPEndpoint for each of the registered identifiers in the list.

Do not use cache

Parameters
idsThe list of identifiers to look up
Returns
The list of NameAssignments representing a pair of identifier and mapped IPEndpoint for that identifier. If any of the requested identifiers are not registered with the NameService, their corresponding NameAssignment IPEndpoint value will be null.

Implements Org.Apache.REEF.Common.Io.INameClient.

void Org.Apache.REEF.Network.Naming.NameClient.Register ( string  id,
IPEndPoint  endpoint 
)
inline

Synchronously registers the identifier with the NameService.

Overwrites the previous mapping if the identifier has already been registered.

Parameters
idThe key used to map the remote endpoint
endpointThe endpoint to map

Implements Org.Apache.REEF.Common.Io.INameClient.

void Org.Apache.REEF.Network.Naming.NameClient.Restart ( IPEndPoint  serverEndpoint)
inline

Restart the name client in case of failure.

Parameters
serverEndpointThe new server endpoint to connect to

Implements Org.Apache.REEF.Common.Io.INameClient.

void Org.Apache.REEF.Network.Naming.NameClient.Unregister ( string  id)
inline

Synchronously unregisters the remote identifier with the NameService

Parameters
idThe identifier to unregister

Implements Org.Apache.REEF.Common.Io.INameClient.


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