org.nd4j.parameterserver.distributed.transport

Class BaseTransport

java.lang.Object

org.nd4j.parameterserver.distributed.transport.BaseTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

MulticastTransport, RoutedTransport

Deprecated.

@Deprecated
public abstract class BaseTransport
extends java.lang.Object
implements Transport

Author:

[email protected]

Nested Class Summary

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

Transport.ThreadingModel

Field Summary

Fields

Modifier and Type	Field and Description
protected io.aeron.Aeron	aeron Deprecated.
protected Clipboard	clipboard Deprecated.
protected java.util.Map<java.lang.Long,MeaningfulMessage>	completed Deprecated.
protected io.aeron.Aeron.Context	context Deprecated.
protected io.aeron.driver.MediaDriver	driver Deprecated.
protected org.agrona.concurrent.IdleStrategy	feedbackIdler Deprecated.
protected java.util.concurrent.atomic.AtomicLong	frameCount Deprecated.
protected org.agrona.concurrent.IdleStrategy	idler Deprecated.
protected java.lang.String	ip Deprecated.
protected io.aeron.FragmentAssembler	messageHandlerForClients Deprecated.
protected io.aeron.FragmentAssembler	messageHandlerForShards Deprecated.
protected java.util.concurrent.LinkedBlockingQueue<VoidMessage>	messages Deprecated.
protected NodeRole	nodeRole Deprecated.
protected long	originatorId Deprecated.
protected int	port Deprecated.
protected io.aeron.Publication	publicationForClients Deprecated.
protected io.aeron.Publication	publicationForShards Deprecated.
protected java.util.concurrent.atomic.AtomicBoolean	runner Deprecated.
protected short	shardIndex Deprecated.
protected io.aeron.Subscription	subscriptionForClients Deprecated.
protected io.aeron.Subscription	subscriptionForShards Deprecated.
protected short	targetIndex Deprecated.
protected java.lang.Thread	threadA Deprecated.
protected java.lang.Thread	threadB Deprecated.
protected Transport.ThreadingModel	threadingModel Deprecated.
protected java.lang.String	unicastChannelUri Deprecated.
protected VoidConfiguration	voidConfiguration Deprecated.

Constructor Summary

Constructors

Constructor and Description
BaseTransport() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addClient(java.lang.String ip, int port) Deprecated.
void	addShard(java.lang.String ip, int port) Deprecated.
protected void	clientMessageHandler(org.agrona.DirectBuffer buffer, int offset, int length, io.aeron.logbuffer.Header header) Deprecated. This message handler is responsible for receiving messages on Client side
java.lang.String	getIp() Deprecated.
long	getOwnOriginatorId() Deprecated. This method returns ID of this Transport instance
int	getPort() Deprecated.
void	init(VoidConfiguration voidConfiguration, Clipboard clipboard, NodeRole role, java.lang.String localIp, int localPort, short shardIndex) Deprecated. This method does initialization of Transport instance
protected void	internalMessageHandler(org.agrona.DirectBuffer buffer, int offset, int length, io.aeron.logbuffer.Header header) Deprecated. This message handler is responsible for receiving coordination messages on Shard side
void	launch(Transport.ThreadingModel threading) Deprecated. This method starts transport mechanisms.
int	numberOfKnownClients() Deprecated. This method returns number of known Clients
int	numberOfKnownShards() Deprecated. This method returns number of known Shards
VoidMessage	peekMessage() Deprecated. This method peeks 1 message from "incoming messages" queue, returning null if queue is empty PLEASE NOTE: This method is suitable for debug purposes only
void	putMessage(VoidMessage message) Deprecated. This method puts message into processing queue
void	receiveMessage(VoidMessage message) Deprecated. This method saves incoming message to the Queue, for later dispatch from higher-level code, like actual TrainingFunction or VoidParameterServer itself
protected void	sendCommandToShard(VoidMessage message) Deprecated. This command is possible to issue only from Client
protected abstract void	sendCoordinationCommand(VoidMessage message) Deprecated. This command is possible to issue only from Shard
protected abstract void	sendFeedbackToClient(VoidMessage message) Deprecated. This command is possible to issue only from Shard
void	sendMessage(VoidMessage message) Deprecated. This method accepts message for delivery, routing is applied according on message opType
MeaningfulMessage	sendMessageAndGetResponse(VoidMessage message) Deprecated. This method accepts message for delivery, and blocks until response delivered
void	sendMessageToAllClients(VoidMessage message, java.lang.Long... exclusions) Deprecated.
void	sendMessageToAllShards(VoidMessage message) Deprecated.
void	setIpAndPort(java.lang.String ip, int port) Deprecated.
protected void	shardMessageHandler(org.agrona.DirectBuffer buffer, int offset, int length, io.aeron.logbuffer.Header header) Deprecated. This message handler is responsible for receiving messages on Shard side
void	shutdown() Deprecated. This method stops transport system.
protected void	shutdownSilent() Deprecated.
VoidMessage	takeMessage() Deprecated. This method takes 1 message from "incoming messages" queue, blocking if queue is empty

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

voidConfiguration

protected VoidConfiguration voidConfiguration

Deprecated.

nodeRole

protected NodeRole nodeRole

Deprecated.

aeron

protected io.aeron.Aeron aeron

Deprecated.

context

protected io.aeron.Aeron.Context context

Deprecated.

unicastChannelUri

protected java.lang.String unicastChannelUri

Deprecated.

ip

protected java.lang.String ip

Deprecated.

port

protected int port

Deprecated.

driver

protected io.aeron.driver.MediaDriver driver

Deprecated.

publicationForShards

protected io.aeron.Publication publicationForShards

Deprecated.

publicationForClients

protected io.aeron.Publication publicationForClients

Deprecated.

subscriptionForShards

protected io.aeron.Subscription subscriptionForShards

Deprecated.

subscriptionForClients

protected io.aeron.Subscription subscriptionForClients

Deprecated.

messageHandlerForShards

protected io.aeron.FragmentAssembler messageHandlerForShards

Deprecated.

messageHandlerForClients

protected io.aeron.FragmentAssembler messageHandlerForClients

Deprecated.

messages

protected java.util.concurrent.LinkedBlockingQueue<VoidMessage> messages

Deprecated.

completed

protected java.util.Map<java.lang.Long,MeaningfulMessage> completed

Deprecated.

runner

protected java.util.concurrent.atomic.AtomicBoolean runner

Deprecated.

threadA

protected java.lang.Thread threadA

Deprecated.

threadB

protected java.lang.Thread threadB

Deprecated.

clipboard

protected Clipboard clipboard

Deprecated.

frameCount

protected java.util.concurrent.atomic.AtomicLong frameCount

Deprecated.

idler

protected org.agrona.concurrent.IdleStrategy idler

Deprecated.

feedbackIdler

protected org.agrona.concurrent.IdleStrategy feedbackIdler

Deprecated.

threadingModel

protected Transport.ThreadingModel threadingModel

Deprecated.

originatorId

protected long originatorId

Deprecated.

targetIndex

protected short targetIndex

Deprecated.

shardIndex

protected short shardIndex

Deprecated.

Constructor Detail

BaseTransport

public BaseTransport()

Deprecated.

Method Detail

getOwnOriginatorId

public long getOwnOriginatorId()

Deprecated.

Description copied from interface: Transport

This method returns ID of this Transport instance

Specified by:

getOwnOriginatorId in interface Transport

Returns:

sendMessageAndGetResponse

public MeaningfulMessage sendMessageAndGetResponse(@NonNull
                                                   VoidMessage message)

Deprecated.

Description copied from interface: Transport

This method accepts message for delivery, and blocks until response delivered

Specified by:

sendMessageAndGetResponse in interface Transport

Returns:

setIpAndPort

public void setIpAndPort(@NonNull
                         java.lang.String ip,
                         int port)

Deprecated.

Specified by:

setIpAndPort in interface Transport

sendMessage

public void sendMessage(@NonNull
                        VoidMessage message)

Deprecated.

Description copied from interface: Transport

This method accepts message for delivery, routing is applied according on message opType

Specified by:

sendMessage in interface Transport

shardMessageHandler

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

Deprecated.

This message handler is responsible for receiving messages on Shard side

Parameters:

buffer -

offset -

length -

header -

internalMessageHandler

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

Deprecated.

This message handler is responsible for receiving coordination messages on Shard side

Parameters:

buffer -

offset -

length -

header -

clientMessageHandler

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

Deprecated.

This message handler is responsible for receiving messages on Client side

Parameters:

buffer -

offset -

length -

header -

sendMessageToAllShards

public void sendMessageToAllShards(VoidMessage message)

Deprecated.

Specified by:

sendMessageToAllShards in interface Transport

Parameters:

message -

init

public void init(VoidConfiguration voidConfiguration,
                 Clipboard clipboard,
                 NodeRole role,
                 java.lang.String localIp,
                 int localPort,
                 short shardIndex)

Deprecated.

This method does initialization of Transport instance

Specified by:

init in interface Transport

Parameters:

voidConfiguration -

clipboard -

role -

localIp -

localPort -

shardIndex -

launch

public void launch(@NonNull
                   Transport.ThreadingModel threading)

Deprecated.

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

Specified by:

launch in interface Transport

shutdownSilent

protected void shutdownSilent()

Deprecated.

shutdown

public void shutdown()

Deprecated.

This method stops transport system.

Specified by:

shutdown in interface Transport

receiveMessage

public void receiveMessage(VoidMessage message)

Deprecated.

This method saves incoming message to the Queue, for later dispatch from higher-level code, like actual TrainingFunction or VoidParameterServer itself

Specified by:

receiveMessage in interface Transport

Parameters:

message -

takeMessage

public VoidMessage takeMessage()

Deprecated.

This method takes 1 message from "incoming messages" queue, blocking if queue is empty

Specified by:

takeMessage in interface Transport

Returns:

putMessage

public void putMessage(@NonNull
                       VoidMessage message)

Deprecated.

This method puts message into processing queue

Specified by:

putMessage in interface Transport

Parameters:

message -

peekMessage

public VoidMessage peekMessage()

Deprecated.

This method peeks 1 message from "incoming messages" queue, returning null if queue is empty PLEASE NOTE: This method is suitable for debug purposes only

Specified by:

peekMessage in interface Transport

Returns:

sendCommandToShard

protected void sendCommandToShard(VoidMessage message)

Deprecated.

This command is possible to issue only from Client

Parameters:

message -

sendCoordinationCommand

protected abstract void sendCoordinationCommand(VoidMessage message)

Deprecated.

This command is possible to issue only from Shard

Parameters:

message -

sendFeedbackToClient

protected abstract void sendFeedbackToClient(VoidMessage message)

Deprecated.

This command is possible to issue only from Shard

Parameters:

message -

addClient

public void addClient(java.lang.String ip,
                      int port)

Deprecated.

Specified by:

addClient in interface Transport

getIp

public java.lang.String getIp()

Deprecated.

Specified by:

getIp in interface Transport

getPort

public int getPort()

Deprecated.

Specified by:

getPort in interface Transport

numberOfKnownClients

public int numberOfKnownClients()

Deprecated.

Description copied from interface: Transport

This method returns number of known Clients

Specified by:

numberOfKnownClients in interface Transport

Returns:

numberOfKnownShards

public int numberOfKnownShards()

Deprecated.

Description copied from interface: Transport

This method returns number of known Shards

Specified by:

numberOfKnownShards in interface Transport

Returns:

addShard

public void addShard(java.lang.String ip,
                     int port)

Deprecated.

Specified by:

addShard in interface Transport

sendMessageToAllClients

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

Deprecated.

Specified by:

sendMessageToAllClients in interface Transport