Module org.elasticsearch.server

Package org.elasticsearch.transport

Interface TcpChannel

All Superinterfaces:

AutoCloseable, Closeable, CloseableChannel

public interface TcpChannel
extends CloseableChannel

This is a tcp channel representing a single channel connection to another node. It is the base channel abstraction used by the TcpTransport and TransportService. All tcp transport implementations must return channels that adhere to the required method contracts.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TcpChannel.ChannelStats

Method Summary

Modifier and Type	Method	Description
void	addConnectListener(ActionListener<Void> listener)	Adds a listener that will be executed when the channel is connected.
TcpChannel.ChannelStats	getChannelStats()	Returns stats about this channel
InetSocketAddress	getLocalAddress()	Returns the local address for this channel.
String	getProfile()	This returns the profile for this channel.
InetSocketAddress	getRemoteAddress()	Returns the remote address for this channel.
boolean	isServerChannel()	Indicates if the channel is an inbound server channel.
void	sendMessage(BytesReference reference, ActionListener<Void> listener)	Sends a tcp message to the channel.

Methods inherited from interface org.elasticsearch.common.network.CloseableChannel

addCloseListener, close, isOpen

Method Details

isServerChannel

boolean isServerChannel()

Indicates if the channel is an inbound server channel.

getProfile

String getProfile()

This returns the profile for this channel.

getLocalAddress

InetSocketAddress getLocalAddress()

Returns the local address for this channel.

Returns:

the local address of this channel.

getRemoteAddress

InetSocketAddress getRemoteAddress()

Returns the remote address for this channel. Can be null if channel does not have a remote address.

Returns:

the remote address of this channel.

sendMessage

void sendMessage(BytesReference reference,
 ActionListener<Void> listener)

Sends a tcp message to the channel. The listener will be executed once the send process has been completed.

Parameters:

reference - to send to channel

listener - to execute upon send completion

addConnectListener

void addConnectListener(ActionListener<Void> listener)

Adds a listener that will be executed when the channel is connected. If the channel is still unconnected when this listener is added, the listener will be executed by the thread that eventually finishes the channel connection. If the channel is already connected when the listener is added the listener will immediately be executed by the thread that is attempting to add the listener.

Parameters:

listener - to be executed

getChannelStats

TcpChannel.ChannelStats getChannelStats()

Returns stats about this channel