Package org.elasticsearch.transport

Interface Transport.Connection

All Superinterfaces:

AutoCloseable, Closeable, org.elasticsearch.core.RefCounted

All Known Implementing Classes:

CloseableConnection, TcpTransport.NodeChannels

Enclosing interface:

Transport

public static interface Transport.Connection
extends Closeable, org.elasticsearch.core.RefCounted

A unidirectional connection to a DiscoveryNode

Method Summary

Modifier and Type	Method	Description
void	addCloseListener(ActionListener<Void> listener)	The listener's ActionListener.onResponse(Object) method will be called when this connection is closed.
void	addRemovedListener(ActionListener<Void> listener)	Similar to addCloseListener(org.elasticsearch.action.ActionListener<java.lang.Void>) except that these listeners are notified once the connection is removed from the transport service.
void	close()
default Object	getCacheKey()	Returns a key that this connection can be cached on.
DiscoveryNode	getNode()	The node this connection is associated with
default Version	getVersion()	Returns the version of the node this connection was established with.
boolean	isClosed()
void	onRemoved()	Called after this connection is removed from the transport service.
void	sendRequest(long requestId, String action, TransportRequest request, TransportRequestOptions options)	Sends the request to the node this connection is associated with

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, tryIncRef

Method Details

getNode

DiscoveryNode getNode()

The node this connection is associated with

sendRequest

void sendRequest(long requestId,
 String action,
 TransportRequest request,
 TransportRequestOptions options)
          throws IOException,
TransportException

Sends the request to the node this connection is associated with

Parameters:

requestId - see Transport.ResponseHandlers.add(ResponseContext) for details

action - the action to execute

request - the request to send

options - request options to apply

Throws:

NodeNotConnectedException - if the given node is not connected

IOException

TransportException

addCloseListener

void addCloseListener(ActionListener<Void> listener)

The listener's ActionListener.onResponse(Object) method will be called when this connection is closed. No implementations currently throw an exception during close, so ActionListener.onFailure(Exception) will not be called.

Parameters:

listener - to be called

isClosed

boolean isClosed()

getVersion

default Version getVersion()

Returns the version of the node this connection was established with.

getCacheKey

default Object getCacheKey()

Returns a key that this connection can be cached on. Delegating subclasses must delegate method call to the original connection.

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

onRemoved

void onRemoved()

Called after this connection is removed from the transport service.

addRemovedListener

void addRemovedListener(ActionListener<Void> listener)

Similar to addCloseListener(org.elasticsearch.action.ActionListener<java.lang.Void>) except that these listeners are notified once the connection is removed from the transport service.