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

Class NettyTransportClient

java.lang.Object

org.apache.hugegraph.computer.core.network.netty.NettyTransportClient

All Implemented Interfaces:

TransportClient

public class NettyTransportClient
extends java.lang.Object
implements TransportClient

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NettyTransportClient(io.netty.channel.Channel channel, ConnectionId connectionId, NettyClientFactory clientFactory, ClientHandler clientHandler)

Method Summary

Modifier and Type	Method	Description
boolean	active()	To check whether the connection is active to use
io.netty.channel.Channel	channel()
protected void	checkAndNotifySendAvailable()
protected boolean	checkSendAvailable()
ClientHandler	clientHandler()
protected ClientSession	clientSession()
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 TransportClient.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 TransportClient.startSession().

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyTransportClient

protected NettyTransportClient(io.netty.channel.Channel channel,
                               ConnectionId connectionId,
                               NettyClientFactory clientFactory,
                               ClientHandler clientHandler)

Method Detail

channel

public io.netty.channel.Channel channel()

connectionId

public ConnectionId connectionId()

Description copied from interface: TransportClient

Get the ConnectionId

Specified by:

connectionId in interface TransportClient

remoteAddress

public java.net.InetSocketAddress remoteAddress()

Description copied from interface: TransportClient

Get the remote SocketAddress

Specified by:

remoteAddress in interface TransportClient

active

public boolean active()

Description copied from interface: TransportClient

To check whether the connection is active to use

Specified by:

active in interface TransportClient

Returns:

true if connection is active

sessionActive

public boolean sessionActive()

Description copied from interface: TransportClient

To check whether the session is active to use

Specified by:

sessionActive in interface TransportClient

Returns:

true if session is active

clientSession

protected ClientSession clientSession()

clientHandler

public ClientHandler clientHandler()

startSessionAsync

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

Description copied from interface: TransportClient

This method is the asynchronous version of TransportClient.startSession().

Specified by:

startSessionAsync in interface TransportClient

startSession

public void startSession()
                  throws TransportException

Description copied from interface: TransportClient

This method is called before an iteration of sending buffers.

Specified by:

startSession in interface TransportClient

Throws:

TransportException

send

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

Description copied from interface: TransportClient

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

Specified by:

send in interface TransportClient

Throws:

TransportException - if failed, the job will fail.

finishSessionAsync

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

Description copied from interface: TransportClient

This method is the asynchronous version of TransportClient.finishSession().

Specified by:

finishSessionAsync in interface TransportClient

finishSession

public void finishSession()
                   throws TransportException

Description copied from interface: TransportClient

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

Specified by:

finishSession in interface TransportClient

Throws:

TransportException

checkSendAvailable

protected boolean checkSendAvailable()

checkAndNotifySendAvailable

protected void checkAndNotifySendAvailable()

close

public void close()

Description copied from interface: TransportClient

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.

Specified by:

close in interface TransportClient