Apache REEF  0.16.0
Retainable Evaluator Execution Framework
Public Member Functions | Properties | List of all members
Org.Apache.REEF.Network.NetworkService.NetworkService< T > Class Template Reference

Network service used for Reef Task communication. More...

Inherits Org.Apache.REEF.Network.NetworkService.INetworkService< T >.

Public Member Functions

 NetworkService ([Parameter(typeof(NetworkServiceOptions.NetworkServicePort))] int nsPort, IObserver< NsMessage< T >> messageHandler, IIdentifierFactory idFactory, ICodec< T > codec, INameClient nameClient, ILocalAddressProvider localAddressProvider, IRemoteManagerFactory remoteManagerFactory)
 Create a new NetworkService. More...
 
IConnection< T > NewConnection (IIdentifier destinationId)
 Open a new connection to the remote host registered to the name service with the given identifier More...
 
void Register (IIdentifier id)
 Register the identifier for the NetworkService with the NameService. More...
 
void Unregister ()
 Unregister the identifier for the NetworkService with the NameService. More...
 
void Dispose ()
 Dispose of the NetworkService's resources More...
 

Properties

INameClient NamingClient [get]
 Name client for registering ids More...
 
IRemoteManager< NsMessage< T > > RemoteManager [get]
 The remote manager of the network service. More...
 
- Properties inherited from Org.Apache.REEF.Network.NetworkService.INetworkService< T >
INameClient NamingClient [get]
 Name client for registering ids More...
 
IRemoteManager< NsMessage< T > > RemoteManager [get]
 The remote manager of the NetworkService. More...
 

Detailed Description

Network service used for Reef Task communication.

Template Parameters
TThe message type

Constructor & Destructor Documentation

◆ NetworkService()

Org.Apache.REEF.Network.NetworkService.NetworkService< T >.NetworkService ( [Parameter(typeof(NetworkServiceOptions.NetworkServicePort))] int  nsPort,
IObserver< NsMessage< T >>  messageHandler,
IIdentifierFactory  idFactory,
ICodec< T >  codec,
INameClient  nameClient,
ILocalAddressProvider  localAddressProvider,
IRemoteManagerFactory  remoteManagerFactory 
)
inline

Create a new NetworkService.

Parameters
nsPortThe port that the NetworkService will listen on
messageHandlerThe observer to handle incoming messages
idFactoryThe factory used to create IIdentifiers
codecThe codec used for serialization
nameClient
localAddressProviderThe local address provider
remoteManagerFactoryUsed to instantiate remote manager instances.

Member Function Documentation

◆ Dispose()

Dispose of the NetworkService's resources

◆ NewConnection()

IConnection<T> Org.Apache.REEF.Network.NetworkService.NetworkService< T >.NewConnection ( IIdentifier  destinationId)
inline

Open a new connection to the remote host registered to the name service with the given identifier

Parameters
destinationIdThe identifier of the remote host
Returns
The IConnection used for communication

Implements Org.Apache.REEF.Network.NetworkService.INetworkService< T >.

◆ Register()

Register the identifier for the NetworkService with the NameService.

Parameters
idThe identifier to register

Implements Org.Apache.REEF.Network.NetworkService.INetworkService< T >.

◆ Unregister()

Unregister the identifier for the NetworkService with the NameService.

Implements Org.Apache.REEF.Network.NetworkService.INetworkService< T >.

Property Documentation

◆ NamingClient

Name client for registering ids

◆ RemoteManager

The remote manager of the network service.


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