edu.iu.dsc.tws.api.comms.channel

Interface TWSChannel

All Known Implementing Classes:

TWSMPIChannel, TWSTCPChannel, TWSUCXChannel

public interface TWSChannel

Represent a communication channel. A MPI channel or a TCP channel.

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

Method Detail

sendMessage

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

Send a message

Parameters:

id - worker id

message - message

callback - callback for message completions

Returns:

true if sending is accepted

receiveMessage

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

Receive a message

Parameters:

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

void progress()

Progress both sends and receives

progressSends

void progressSends()

Progress only the sends

progressReceives

void progressReceives(int group)

Progress only receives belonging to a group

isComplete

boolean isComplete()

Check weather we have any pending sends

createBuffer

java.nio.ByteBuffer createBuffer(int capacity)

Create a buffer

Parameters:

capacity - capacity

Returns:

the byte buffer

close

void close()

Close the channel

releaseBuffers

void releaseBuffers(int wId,
                    int e)

Release the buffers for worker and edge

Parameters:

wId - worker

e - edge

reInit

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

re-initialize the channel with restarted workers

Parameters:

restartedWorkers -