edu.iu.dsc.tws.comms.ucx

Class TWSUCXChannel

java.lang.Object

edu.iu.dsc.tws.comms.ucx.TWSUCXChannel

All Implemented Interfaces:

TWSChannel

public class TWSUCXChannel
extends java.lang.Object
implements TWSChannel

This class uses UCX framework underneath to connect to the twister2's network of Worker processes. TWSUCXChannel leverages tags based communication of UCX to virtually create multiple communication channels between the workers based on the edge. The tag for each message is calculated as follows.

tag = sendingWorkerId * tagWIdOffset + edge

Since:

0.5.0

Constructor Summary

Constructors

Constructor and Description
TWSUCXChannel(Config config, IWorkerController workerController)

Method Summary

Modifier and Type	Method and Description
void	close() Close the channel
java.nio.ByteBuffer	createBuffer(int capacity) Create a buffer
boolean	isComplete() Check weather we have any pending sends
void	progress() Progress both sends and receives
void	progressReceives(int group) Progress only receives belonging to a group
void	progressSends() Progress only the sends
boolean	receiveMessage(int group, int id, int edge, ChannelListener callback, java.util.Queue<DataBuffer> receiveBuffers) Receive a message
void	reInit(java.util.List<JobMasterAPI.WorkerInfo> restartedWorkers) re-initialize the channel with restarted workers
void	releaseBuffers(int wId, int e) Release the buffers for worker and edge
boolean	sendMessage(int id, ChannelMessage message, ChannelListener callback) Send a message

Methods inherited from class java.lang.Object

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

Constructor Detail

TWSUCXChannel

public TWSUCXChannel(Config config,
                     IWorkerController workerController)

Method Detail

sendMessage

public boolean sendMessage(int id,
                           ChannelMessage message,
                           ChannelListener callback)

Description copied from interface: TWSChannel

Send a message

Specified by:

sendMessage in interface TWSChannel

Parameters:

id - worker id

message - message

callback - callback for message completions

Returns:

true if sending is accepted

receiveMessage

public boolean receiveMessage(int group,
                              int id,
                              int edge,
                              ChannelListener callback,
                              java.util.Queue<DataBuffer> receiveBuffers)

Description copied from interface: TWSChannel

Receive a message

Specified by:

receiveMessage in interface TWSChannel

id - worker id

edge - the graph edge to receive from

callback - callback for message completions

receiveBuffers - the list of receive buffers

Returns:

true if sending is accepted

progress

public void progress()

Description copied from interface: TWSChannel

Progress both sends and receives

Specified by:

progress in interface TWSChannel

progressSends

public void progressSends()

Description copied from interface: TWSChannel

Progress only the sends

Specified by:

progressSends in interface TWSChannel

progressReceives

public void progressReceives(int group)

Description copied from interface: TWSChannel

Progress only receives belonging to a group

Specified by:

progressReceives in interface TWSChannel

isComplete

public boolean isComplete()

Description copied from interface: TWSChannel

Check weather we have any pending sends

Specified by:

isComplete in interface TWSChannel

createBuffer

public java.nio.ByteBuffer createBuffer(int capacity)

Description copied from interface: TWSChannel

Create a buffer

Specified by:

createBuffer in interface TWSChannel

Parameters:

capacity - capacity

Returns:

the byte buffer

close

public void close()

Description copied from interface: TWSChannel

Close the channel

Specified by:

close in interface TWSChannel

releaseBuffers

public void releaseBuffers(int wId,
                           int e)

Description copied from interface: TWSChannel

Release the buffers for worker and edge

Specified by:

releaseBuffers in interface TWSChannel

Parameters:

wId - worker

e - edge

reInit

public void reInit(java.util.List<JobMasterAPI.WorkerInfo> restartedWorkers)

Description copied from interface: TWSChannel

re-initialize the channel with restarted workers

Specified by:

reInit in interface TWSChannel