org.nd4j.parameterserver.distributed.v2.util

Class MeshOrganizer

java.lang.Object

org.nd4j.parameterserver.distributed.v2.util.MeshOrganizer

All Implemented Interfaces:

java.io.Serializable

public class MeshOrganizer
extends java.lang.Object
implements java.io.Serializable

This class provides methods for ephemeral mesh network management

Author:

[email protected]

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MeshOrganizer.Node This class represents basic tree node

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Queue<MeshOrganizer.Node>	fillQueue
static int	MAX_DEPTH
static int	MAX_DOWNSTREAMS

Constructor Summary

Constructors

Constructor and Description
MeshOrganizer()
MeshOrganizer(MeshBuildMode mode) Deprecated.

Method Summary

Modifier and Type	Method and Description
MeshOrganizer.Node	addNode(MeshOrganizer.Node node) This method adds new node to the mesh
MeshOrganizer.Node	addNode(java.lang.String ip) This method adds new node to the network PLEASE NOTE: Default port 40123 is used
MeshOrganizer.Node	addNode(java.lang.String ip, int port) This methods adds new node to the network
MeshOrganizer	clone() This method returns absolutely independent copy of this Mesh
boolean	equals(java.lang.Object o)
java.util.Collection<MeshOrganizer.Node>	flatNodes() This method returns our mesh as collection of nodes
protected long	flatSize() This method returns size of flattened map of nodes.
java.util.Collection<MeshOrganizer.Node>	getDownstreamsForNode(java.lang.String ip) This method returns downstream connections for a given node
MeshOrganizer.Node	getNodeById(java.lang.String id) This method returns Node representing given IP
MeshOrganizer.Node	getUpstreamForNode(java.lang.String ip) This method returns upstream connection for a given node
long	getVersion()
int	hashCode()
boolean	isKnownNode(java.lang.String id) This method returns true, if node is known
void	markNodeOffline(MeshOrganizer.Node node) This method marks given Node as offline, remapping its downstreams
void	markNodeOffline(java.lang.String ip) This method marks Node (specified by IP) as offline, and remaps its downstreams
long	numberOfDescendantsOfNode() This method returns total number of nodes below given one
void	remapNode(MeshOrganizer.Node node) This method reconnects given node to another node
void	remapNode(java.lang.String ip) This method reconnects given node to another node
void	remapNodeAndDownstreams(MeshOrganizer.Node node) This method remaps node and its downstreams somewhere
void	remapNodeAndDownstreams(java.lang.String ip) This method reconnects given node to another node
void	removeNode() This method removes node from tree
long	totalNodes() This method returns total number of nodes in this mesh PLESE NOTE: this method INCLUDES root node

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_DOWNSTREAMS

public static final int MAX_DOWNSTREAMS

See Also:

Constant Field Values

MAX_DEPTH

public static final int MAX_DEPTH

See Also:

Constant Field Values

fillQueue

protected transient java.util.Queue<MeshOrganizer.Node> fillQueue

Constructor Detail

MeshOrganizer

public MeshOrganizer()

MeshOrganizer

@Deprecated
public MeshOrganizer(@NonNull
                                 MeshBuildMode mode)

Deprecated.

Method Detail

getVersion

public long getVersion()

addNode

public MeshOrganizer.Node addNode(@NonNull
                                  java.lang.String ip)

This method adds new node to the network PLEASE NOTE: Default port 40123 is used

Parameters:

ip -

addNode

public MeshOrganizer.Node addNode(@NonNull
                                  java.lang.String ip,
                                  @NonNull
                                  int port)

This methods adds new node to the network

clone

public MeshOrganizer clone()

This method returns absolutely independent copy of this Mesh

Overrides:

clone in class java.lang.Object

Returns:

addNode

public MeshOrganizer.Node addNode(@NonNull
                                  MeshOrganizer.Node node)

This method adds new node to the mesh

Parameters:

node -

Returns:

markNodeOffline

public void markNodeOffline(@NonNull
                            java.lang.String ip)
                     throws java.util.NoSuchElementException

This method marks Node (specified by IP) as offline, and remaps its downstreams

Parameters:

ip -

Throws:

java.util.NoSuchElementException

markNodeOffline

public void markNodeOffline(@NonNull
                            MeshOrganizer.Node node)

This method marks given Node as offline, remapping its downstreams

Parameters:

node -

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

remapNode

public void remapNode(@NonNull
                      java.lang.String ip)

This method reconnects given node to another node

remapNodeAndDownstreams

public void remapNodeAndDownstreams(@NonNull
                                    java.lang.String ip)

This method reconnects given node to another node

remapNodeAndDownstreams

public void remapNodeAndDownstreams(@NonNull
                                    MeshOrganizer.Node node)

This method remaps node and its downstreams somewhere

Parameters:

node -

remapNode

public void remapNode(@NonNull
                      MeshOrganizer.Node node)

This method reconnects given node to another node

removeNode

public void removeNode()

This method removes node from tree

isKnownNode

public boolean isKnownNode(@NonNull
                           java.lang.String id)

This method returns true, if node is known

Returns:

getUpstreamForNode

public MeshOrganizer.Node getUpstreamForNode(@NonNull
                                             java.lang.String ip)
                                      throws java.util.NoSuchElementException

This method returns upstream connection for a given node

Throws:

java.util.NoSuchElementException

getDownstreamsForNode

public java.util.Collection<MeshOrganizer.Node> getDownstreamsForNode(@NonNull
                                                                      java.lang.String ip)
                                                               throws java.util.NoSuchElementException

This method returns downstream connections for a given node

Throws:

java.util.NoSuchElementException

numberOfDescendantsOfNode

public long numberOfDescendantsOfNode()

This method returns total number of nodes below given one

Returns:

totalNodes

public long totalNodes()

This method returns total number of nodes in this mesh PLESE NOTE: this method INCLUDES root node

Returns:

flatSize

protected long flatSize()

This method returns size of flattened map of nodes. Suited for tests.

Returns:

flatNodes

public java.util.Collection<MeshOrganizer.Node> flatNodes()

This method returns our mesh as collection of nodes

Returns:

getNodeById

public MeshOrganizer.Node getNodeById(@NonNull
                                      java.lang.String id)
                               throws java.util.NoSuchElementException

This method returns Node representing given IP

Returns:

Throws:

java.util.NoSuchElementException