Package org.apache.hugegraph.computer.core.network

Interface TransportClient

All Known Implementing Classes:

NettyTransportClient

public interface TransportClient

This is used for worker to send buffer to other worker. The whole process contains several iteration. In one iteration startSession() is called only once. send(org.apache.hugegraph.computer.core.network.message.MessageType, int, java.nio.ByteBuffer) is called zero or more times. finishSession() is called only once.

Method Summary

Modifier and Type	Method	Description
boolean	active()	To check whether the connection is active to use
void	close()	Close the client.
ConnectionId	connectionId()	Get the ConnectionId
void	finishSession()	This method is called after an iteration.
java.util.concurrent.CompletableFuture<java.lang.Void>	finishSessionAsync()	This method is the asynchronous version of finishSession().
java.net.InetSocketAddress	remoteAddress()	Get the remote SocketAddress
boolean	send(MessageType messageType, int partition, java.nio.ByteBuffer buffer)	Send the buffer to the server.
boolean	sessionActive()	To check whether the session is active to use
void	startSession()	This method is called before an iteration of sending buffers.
java.util.concurrent.CompletableFuture<java.lang.Void>	startSessionAsync()	This method is the asynchronous version of startSession().

Method Detail

startSession

void startSession()
           throws TransportException

This method is called before an iteration of sending buffers.

Throws:

TransportException

startSessionAsync

java.util.concurrent.CompletableFuture<java.lang.Void> startSessionAsync()
                                                                  throws TransportException

This method is the asynchronous version of startSession().

Throws:

TransportException

send

boolean send(MessageType messageType,
             int partition,
             java.nio.ByteBuffer buffer)
      throws TransportException

Send the buffer to the server. Return false if unable send data immediately. This method is called zero or many times in iteration.

Throws:

TransportException - if failed, the job will fail.

finishSession

void finishSession()
            throws TransportException

This method is called after an iteration. It will block the caller to make sure the buffers sent be received by target workers.

Throws:

TransportException

finishSessionAsync

java.util.concurrent.CompletableFuture<java.lang.Void> finishSessionAsync()
                                                                   throws TransportException

This method is the asynchronous version of finishSession().

Throws:

TransportException

connectionId

ConnectionId connectionId()

Get the ConnectionId

remoteAddress

java.net.InetSocketAddress remoteAddress()

Get the remote SocketAddress

active

boolean active()

To check whether the connection is active to use

Returns:

true if connection is active

sessionActive

boolean sessionActive()

To check whether the session is active to use

Returns:

true if session is active

close

void close()

Close the client. NOTE: If the client is created with ConnectionManager, need to use ConnectionManager.closeClient(ConnectionId) to close it, otherwise there will be unsafe risks.