org.nd4j.parameterserver.distributed.transport

Class RoutedTransport

java.lang.Object

org.nd4j.parameterserver.distributed.transport.BaseTransport

org.nd4j.parameterserver.distributed.transport.RoutedTransport

All Implemented Interfaces:

Transport

public class RoutedTransport
extends BaseTransport

Transport implementation based on UDP unicast, for restricted environments, where multicast isn't available. I.e. AWS or Azure

Author:

raver119@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoutedTransport.RemoteConnection

Nested classes/interfaces inherited from interface org.nd4j.parameterserver.distributed.transport.Transport

Transport.ThreadingModel

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Long,RoutedTransport.RemoteConnection>	clients
protected ClientRouter	router
protected List<RoutedTransport.RemoteConnection>	shards

Fields inherited from class org.nd4j.parameterserver.distributed.transport.BaseTransport

aeron, clipboard, completed, context, driver, feedbackIdler, frameCount, idler, ip, messageHandlerForClients, messageHandlerForShards, messages, nodeRole, originatorId, port, publicationForClients, publicationForShards, runner, shardIndex, subscriptionForClients, subscriptionForShards, targetIndex, threadA, threadB, threadingModel, unicastChannelUri, voidConfiguration

Constructor Summary

Constructors

Constructor and Description
RoutedTransport()

Method Summary

Modifier and Type	Method and Description
void	addClient(String ip, int port)
void	addShard(String ip, int port)
void	init(VoidConfiguration voidConfiguration, Clipboard clipboard, NodeRole role, String localIp, int localPort, short shardIndex) This method does initialization of Transport instance
protected void	jointMessageHandler(org.agrona.DirectBuffer buffer, int offset, int length, io.aeron.logbuffer.Header header) This message handler is responsible for receiving messages on any side of p2p network
void	launch(Transport.ThreadingModel threading) This method starts transport mechanisms.
int	numberOfKnownClients() This method returns number of known Clients
int	numberOfKnownShards() This method returns number of known Shards
protected void	sendCommandToShard(VoidMessage message) This command is possible to issue only from Client
protected void	sendCoordinationCommand(VoidMessage message) This method implements Shard -> Shards comms
protected void	sendFeedbackToClient(VoidMessage message) This method implements Shard -> Client comms
void	sendMessageToAllClients(VoidMessage message, Long... exclusions)
void	shutdown() This method stops transport system.
protected void	shutdownSilent()

Methods inherited from class org.nd4j.parameterserver.distributed.transport.BaseTransport

clientMessageHandler, getIp, getOwnOriginatorId, getPort, internalMessageHandler, peekMessage, putMessage, receiveMessage, sendMessage, sendMessageAndGetResponse, sendMessageToAllShards, setIpAndPort, shardMessageHandler, takeMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nd4j.parameterserver.distributed.transport.Transport

getShardIndex, getTargetIndex

Field Detail

shards

protected List<RoutedTransport.RemoteConnection> shards

clients

protected Map<Long,RoutedTransport.RemoteConnection> clients

router

protected ClientRouter router

Constructor Detail

RoutedTransport

public RoutedTransport()

Method Detail

init

public void init(@NonNull
                 VoidConfiguration voidConfiguration,
                 @NonNull
                 Clipboard clipboard,
                 @NonNull
                 NodeRole role,
                 @NonNull
                 String localIp,
                 int localPort,
                 short shardIndex)

Description copied from class: BaseTransport

This method does initialization of Transport instance

Specified by:

init in interface Transport

Overrides:

init in class BaseTransport

sendMessageToAllClients

public void sendMessageToAllClients(VoidMessage message,
                                    Long... exclusions)

Specified by:

sendMessageToAllClients in interface Transport

Overrides:

sendMessageToAllClients in class BaseTransport

sendCoordinationCommand

protected void sendCoordinationCommand(VoidMessage message)

This method implements Shard -> Shards comms

Specified by:

sendCoordinationCommand in class BaseTransport

Parameters:

message -

sendFeedbackToClient

protected void sendFeedbackToClient(VoidMessage message)

This method implements Shard -> Client comms

Specified by:

sendFeedbackToClient in class BaseTransport

Parameters:

message -

numberOfKnownClients

public int numberOfKnownClients()

Description copied from interface: Transport

This method returns number of known Clients

Specified by:

numberOfKnownClients in interface Transport

Overrides:

numberOfKnownClients in class BaseTransport

Returns:

numberOfKnownShards

public int numberOfKnownShards()

Description copied from interface: Transport

This method returns number of known Shards

Specified by:

numberOfKnownShards in interface Transport

Overrides:

numberOfKnownShards in class BaseTransport

Returns:

shutdownSilent

protected void shutdownSilent()

Overrides:

shutdownSilent in class BaseTransport

shutdown

public void shutdown()

Description copied from class: BaseTransport

This method stops transport system.

Specified by:

shutdown in interface Transport

Overrides:

shutdown in class BaseTransport

sendCommandToShard

protected void sendCommandToShard(VoidMessage message)

Description copied from class: BaseTransport

This command is possible to issue only from Client

Overrides:

sendCommandToShard in class BaseTransport

jointMessageHandler

protected void jointMessageHandler(org.agrona.DirectBuffer buffer,
                                   int offset,
                                   int length,
                                   io.aeron.logbuffer.Header header)

This message handler is responsible for receiving messages on any side of p2p network

Parameters:

buffer -

offset -

length -

header -

launch

public void launch(@NonNull
                   Transport.ThreadingModel threading)

Description copied from class: BaseTransport

This method starts transport mechanisms. PLEASE NOTE: init() method should be called prior to launch() call

Specified by:

launch in interface Transport

Overrides:

launch in class BaseTransport

addShard

public void addShard(String ip,
                     int port)

Specified by:

addShard in interface Transport

Overrides:

addShard in class BaseTransport

addClient

public void addClient(String ip,
                      int port)

Specified by:

addClient in interface Transport

Overrides:

addClient in class BaseTransport