org.nd4j.parameterserver.distributed.v2.transport.impl

Class DummyTransport

java.lang.Object

org.nd4j.parameterserver.distributed.v2.transport.impl.BaseTransport

org.nd4j.parameterserver.distributed.v2.transport.impl.DummyTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

DelayedDummyTransport

public class DummyTransport
extends BaseTransport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DummyTransport.Connector This class is written to mimic network connectivity locally

Nested classes/interfaces inherited from class org.nd4j.parameterserver.distributed.v2.transport.impl.BaseTransport

BaseTransport.HeartbeatThread, BaseTransport.MessageFlow<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected DummyTransport.Connector	connector
protected Map<String,MessageCallable>	interceptors
protected Map<String,MessageCallable>	precursors

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

consumers, executorService, handshakeFlag, historyHolder, id, incomingFlow, masterMode, mesh, meshBuildMode, messageQueue, numerOfNodes, outgoingFlow, replies, restartCallback, rootId, splitter, voidConfiguration

Constructor Summary

Constructors

Constructor and Description
DummyTransport(String id, DummyTransport.Connector connector)
DummyTransport(String id, DummyTransport.Connector connector, @NonNull String rootId)
DummyTransport(String id, DummyTransport.Connector connector, @NonNull String rootId, @NonNull VoidConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
<T extends VoidMessage> void	addInterceptor(@NonNull Class<T> cls, @NonNull MessageCallable<T> callable) This method add interceptor for incoming messages.
<T extends VoidMessage> void	addPrecursor(@NonNull Class<T> cls, @NonNull MessageCallable<T> callable) This method add precursor for incoming messages.
MeshOrganizer	getMesh() This method returns Mesh stored in this Transport instance PLEASE NOTE: This method is suited for tests
String	id() This method returns id of the current transport
protected void	internalProcessMessage(VoidMessage message)
boolean	isConnected() This method checks if all connections required for work are established
void	launch() This method starts this Transport instance
void	processMessage(@NonNull VoidMessage message) This method will be invoked for all incoming messages PLEASE NOTE: this method is mostly suited for tests
void	sendMessage(@NonNull VoidMessage message, @NonNull String id) This method will send message to the node specified by Id
void	setMesh(MeshOrganizer mesh)

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

addRequestConsumer, ensureConnection, getRandomDownstreamFrom, getRootId, getUpstreamId, incomingPublisher, isIntroduced, isLoopedNode, launchAsMaster, onMeshUpdate, onRemap, outgoingConsumer, propagateArrayMessage, propagateBroadcastableMessage, propagateMessage, propagateMessageDirect, sendMessageBlocking, sendMessageBlocking, setRestartCallback, shutdown, totalNumberOfNodes

Methods inherited from class java.lang.Object

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

Field Detail

interceptors

protected Map<String,MessageCallable> interceptors

precursors

protected Map<String,MessageCallable> precursors

connector

protected final DummyTransport.Connector connector

Constructor Detail

DummyTransport

public DummyTransport(String id,
                      DummyTransport.Connector connector)

DummyTransport

public DummyTransport(String id,
                      DummyTransport.Connector connector,
                      @NonNull
                      @NonNull String rootId)

DummyTransport

public DummyTransport(String id,
                      DummyTransport.Connector connector,
                      @NonNull
                      @NonNull String rootId,
                      @NonNull
                      @NonNull VoidConfiguration configuration)

Method Detail

launch

public void launch()

Description copied from interface: Transport

This method starts this Transport instance

Specified by:

launch in interface Transport

Overrides:

launch in class BaseTransport

sendMessage

public void sendMessage(@NonNull
                        @NonNull VoidMessage message,
                        @NonNull
                        @NonNull String id)

Description copied from interface: Transport

This method will send message to the node specified by Id

id

public String id()

Description copied from interface: Transport

This method returns id of the current transport

Returns:

addInterceptor

public <T extends VoidMessage> void addInterceptor(@NonNull
                                                   @NonNull Class<T> cls,
                                                   @NonNull
                                                   @NonNull MessageCallable<T> callable)

This method add interceptor for incoming messages. If interceptor is defined for given message class - runnable will be executed instead of processMessage()

Parameters:

cls -

callable -

addPrecursor

public <T extends VoidMessage> void addPrecursor(@NonNull
                                                 @NonNull Class<T> cls,
                                                 @NonNull
                                                 @NonNull MessageCallable<T> callable)

This method add precursor for incoming messages. If precursor is defined for given message class - runnable will be executed before processMessage()

Parameters:

cls -

callable -

processMessage

public void processMessage(@NonNull
                           @NonNull VoidMessage message)

Description copied from interface: Transport

This method will be invoked for all incoming messages PLEASE NOTE: this method is mostly suited for tests

Specified by:

processMessage in interface Transport

Overrides:

processMessage in class BaseTransport

internalProcessMessage

protected void internalProcessMessage(VoidMessage message)

Overrides:

internalProcessMessage in class BaseTransport

getMesh

public MeshOrganizer getMesh()

This method returns Mesh stored in this Transport instance PLEASE NOTE: This method is suited for tests

Returns:

setMesh

public void setMesh(MeshOrganizer mesh)

isConnected

public boolean isConnected()

Description copied from interface: Transport

This method checks if all connections required for work are established

Specified by:

isConnected in interface Transport

Overrides:

isConnected in class BaseTransport

Returns:

true