This project has retired. For details please refer to its Attic page.
Apache REEF: Org.Apache.REEF.Common.Io.INameClient Interface Reference
Apache REEF  0.15.0
Retainable Evaluator Execution Framework
Public Member Functions | List of all members
Org.Apache.REEF.Common.Io.INameClient Interface Reference

Client for the Reef name service. More...

Inherits IDisposable.

Inherited by Org.Apache.REEF.Network.Naming.NameClient.

Public Member Functions

void Register (string id, IPEndPoint endpoint)
 Registers the identifier with the NameService. More...
 
void Unregister (string id)
 Unregisters the remote identifier with the NameService More...
 
IPEndPoint Lookup (string id)
 Looks up the IPEndpoint for the registered identifier. More...
 
IPEndPoint CacheLookup (string id)
 Looks up the IPEndpoint for the registered identifier. More...
 
List< NameAssignmentLookup (List< string > ids)
 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...
 

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.Common.Io.INameClient.CacheLookup ( string  id)

Looks up the IPEndpoint for the registered identifier.

Use 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

Implemented in Org.Apache.REEF.Network.Naming.NameClient.

IPEndPoint Org.Apache.REEF.Common.Io.INameClient.Lookup ( string  id)

Looks up the IPEndpoint for the registered identifier.

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

Implemented in Org.Apache.REEF.Network.Naming.NameClient.

List<NameAssignment> Org.Apache.REEF.Common.Io.INameClient.Lookup ( List< string >  ids)

Looks up the IPEndpoint for each of the registered identifiers in the list.

Parameters
idsThe list of identifiers to look up
Returns
The list of NameAssignments representing a pair of identifer 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.

Implemented in Org.Apache.REEF.Network.Naming.NameClient.

void Org.Apache.REEF.Common.Io.INameClient.Register ( string  id,
IPEndPoint  endpoint 
)

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

Implemented in Org.Apache.REEF.Network.Naming.NameClient.

void Org.Apache.REEF.Common.Io.INameClient.Restart ( IPEndPoint  serverEndpoint)

Restart the name client in case of failure.

Parameters
serverEndpointThe new server endpoint to connect to

Implemented in Org.Apache.REEF.Network.Naming.NameClient.

void Org.Apache.REEF.Common.Io.INameClient.Unregister ( string  id)

Unregisters the remote identifier with the NameService

Parameters
idThe identifier to unregister

Implemented in Org.Apache.REEF.Network.Naming.NameClient.


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