org.nd4j.parameterserver.distributed.messages

Class Frame<T extends TrainingMessage>

java.lang.Object

org.nd4j.parameterserver.distributed.messages.Frame<T>

All Implemented Interfaces:

Serializable, Iterable<T>, VoidMessage

public class Frame<T extends TrainingMessage>
extends Object
implements Serializable, Iterable<T>, VoidMessage

Simple wrapper for multiple request messages OF THE SAME TYPE being stacked into single message

Author:

raver119@gmail.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Clipboard	clipboard
protected List<T>	list
protected long	originatorId
protected int	retransmitCount
protected NodeRole	role
protected short	shardIndex
protected Storage	storage
protected short	targetId
protected long	taskId
protected TrainingDriver<? extends TrainingMessage>	trainer
protected Transport	transport
protected VoidConfiguration	voidConfiguration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Frame()
	Frame(long taskId)
	Frame(T message)

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes()
org.agrona.concurrent.UnsafeBuffer	asUnsafeBuffer()
void	attachContext(VoidConfiguration voidConfiguration, TrainingDriver<? extends TrainingMessage> trainer, Clipboard clipboard, Transport transport, Storage storage, NodeRole role, short shardIndex) This method initializes message for further processing
void	extractContext(BaseVoidMessage message)
Collection<T>	getMessages()
int	getMessageType()
void	incrementRetransmitCount()
boolean	isBlockingMessage()
boolean	isJoinSupported()
Iterator<T>	iterator()
void	joinMessage(VoidMessage message)
void	processMessage() This method will be started in context of executor, either Shard, Client or Backup node
void	setOriginatorId(long id)
int	size()
void	stackMessage(T message) This method adds single TrainingMessage to this Frame PLEASE NOTE: This method is synchronized
void	stackMessages(Collection<T> messages) This method adds multiple messages to this frame PLEASE NOTE: This method is synchronized
void	stackMessages(T... messages) This method adds multiple messages to this frame PLEASE NOTE: This method is synchronized

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.nd4j.parameterserver.distributed.messages.VoidMessage

fromBytes, getOriginatorId, getRetransmitCount, getTargetId, getTaskId, setTargetId

Field Detail

list

protected List<T extends TrainingMessage> list

originatorId

protected long originatorId

targetId

protected short targetId

taskId

protected long taskId

voidConfiguration

protected transient VoidConfiguration voidConfiguration

clipboard

protected transient Clipboard clipboard

transport

protected transient Transport transport

storage

protected transient Storage storage

role

protected transient NodeRole role

shardIndex

protected transient short shardIndex

trainer

protected transient TrainingDriver<? extends TrainingMessage> trainer

retransmitCount

protected transient int retransmitCount

Constructor Detail

Frame

protected Frame()

Frame

public Frame(long taskId)

Frame

public Frame(@NonNull
             T message)

Method Detail

setOriginatorId

public void setOriginatorId(long id)

Specified by:

setOriginatorId in interface VoidMessage

stackMessage

public void stackMessage(@NonNull
                         T message)

This method adds single TrainingMessage to this Frame PLEASE NOTE: This method is synchronized

Parameters:

message -

stackMessages

public void stackMessages(@NonNull
                          Collection<T> messages)

This method adds multiple messages to this frame PLEASE NOTE: This method is synchronized

Parameters:

messages -

stackMessages

public void stackMessages(T... messages)

This method adds multiple messages to this frame PLEASE NOTE: This method is synchronized

Parameters:

messages -

getMessages

public Collection<T> getMessages()

size

public int size()

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends TrainingMessage>

getMessageType

public int getMessageType()

Specified by:

getMessageType in interface VoidMessage

asBytes

public byte[] asBytes()

Specified by:

asBytes in interface VoidMessage

asUnsafeBuffer

public org.agrona.concurrent.UnsafeBuffer asUnsafeBuffer()

Specified by:

asUnsafeBuffer in interface VoidMessage

attachContext

public void attachContext(@NonNull
                          VoidConfiguration voidConfiguration,
                          @NonNull
                          TrainingDriver<? extends TrainingMessage> trainer,
                          @NonNull
                          Clipboard clipboard,
                          @NonNull
                          Transport transport,
                          @NonNull
                          Storage storage,
                          @NonNull
                          NodeRole role,
                          short shardIndex)

Description copied from interface: VoidMessage

This method initializes message for further processing

Specified by:

attachContext in interface VoidMessage

extractContext

public void extractContext(@NonNull
                           BaseVoidMessage message)

Specified by:

extractContext in interface VoidMessage

processMessage

public void processMessage()

Description copied from interface: VoidMessage

This method will be started in context of executor, either Shard, Client or Backup node

Specified by:

processMessage in interface VoidMessage

isJoinSupported

public boolean isJoinSupported()

Specified by:

isJoinSupported in interface VoidMessage

joinMessage

public void joinMessage(VoidMessage message)

Specified by:

joinMessage in interface VoidMessage

isBlockingMessage

public boolean isBlockingMessage()

Specified by:

isBlockingMessage in interface VoidMessage

incrementRetransmitCount

public void incrementRetransmitCount()

Specified by:

incrementRetransmitCount in interface VoidMessage