NettyTransport

java.lang.Object
- org.elasticsearch.common.component.AbstractComponent
- - org.elasticsearch.common.component.AbstractLifecycleComponent<Transport>
  - - org.elasticsearch.transport.netty.NettyTransport

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<Transport>, Releasable, Transport
```
public class NettyTransport
extends AbstractLifecycleComponent<Transport>
implements Transport
```
There are 4 types of connections per node, low/med/high/ping. Low if for batch oriented APIs (like recovery or batch) with high payload that will cause regular request. (like search or single index) to take longer. Med is for the typical search / single doc index. And High for things like cluster state. Ping is reserved for sending out ping requests to other nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`protected class`	`NettyTransport.ChannelCloseListener`
`protected static class`	`NettyTransport.ClientChannelPipelineFactory`
`static class`	`NettyTransport.NodeChannels`
`protected static class`	`NettyTransport.ServerChannelPipelineFactory`

Nested classes/interfaces inherited from interface org.elasticsearch.transport.Transport
Transport.TransportSettings

Field Summary

Fields

Modifier and Type	Field and Description
`protected BigArrays`	`bigArrays`
`protected boolean`	`blockingClient`
`protected BoundTransportAddress`	`boundAddress`
`protected ClientBootstrap`	`clientBootstrap`
`protected boolean`	`compress`
`protected ConcurrentMap<DiscoveryNode,NettyTransport.NodeChannels>`	`connectedNodes`
`protected KeyedLock<String>`	`connectionLock`
`static String`	`CONNECTIONS_PER_NODE_BULK`
`static String`	`CONNECTIONS_PER_NODE_PING`
`static String`	`CONNECTIONS_PER_NODE_RECOVERY`
`static String`	`CONNECTIONS_PER_NODE_REG`
`static String`	`CONNECTIONS_PER_NODE_STATE`
`protected int`	`connectionsPerNodeBulk`
`protected int`	`connectionsPerNodePing`
`protected int`	`connectionsPerNodeRecovery`
`protected int`	`connectionsPerNodeReg`
`protected int`	`connectionsPerNodeState`
`protected TimeValue`	`connectTimeout`
`static TimeValue`	`DEFAULT_PING_SCHEDULE`
`static String`	`DEFAULT_PORT_RANGE`
`static String`	`DEFAULT_PROFILE`
`static String`	`HTTP_SERVER_BOSS_THREAD_NAME_PREFIX`
`static String`	`HTTP_SERVER_WORKER_THREAD_NAME_PREFIX`
`protected int`	`maxCompositeBufferComponents`
`protected ByteSizeValue`	`maxCumulationBufferCapacity`
`protected NetworkService`	`networkService`
`static String`	`PING_SCHEDULE`
`protected Map<String,BoundTransportAddress>`	`profileBoundAddresses`
`protected ReceiveBufferSizePredictorFactory`	`receiveBufferSizePredictorFactory`
`protected ByteSizeValue`	`receivePredictorMax`
`protected ByteSizeValue`	`receivePredictorMin`
`protected Map<String,ServerBootstrap>`	`serverBootstraps`
`protected Map<String,Channel>`	`serverChannels`
`protected OpenChannelsHandler`	`serverOpenChannels`
`protected ThreadPool`	`threadPool`
`static String`	`TRANSPORT_CLIENT_BOSS_THREAD_NAME_PREFIX`
`static String`	`TRANSPORT_CLIENT_WORKER_THREAD_NAME_PREFIX`
`protected TransportServiceAdapter`	`transportServiceAdapter`
`protected Version`	`version`
`static String`	`WORKER_COUNT`
`protected int`	`workerCount`

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
lifecycle

Fields inherited from class org.elasticsearch.common.component.AbstractComponent
componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
`NettyTransport(Settings settings, ThreadPool threadPool, NetworkService networkService, BigArrays bigArrays, Version version)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`TransportAddress[]`	`addressesFromString(String address)` Returns an address from its string representation.
`boolean`	`addressSupported(Class<? extends TransportAddress> address)` Is the address type supported.
`BoundTransportAddress`	`boundAddress()` The address the transport is bound on.
`ChannelPipelineFactory`	`configureClientChannelPipelineFactory()`
`ChannelPipelineFactory`	`configureServerChannelPipelineFactory(String name, Settings settings)`
`protected void`	`connectToChannels(NettyTransport.NodeChannels nodeChannels, DiscoveryNode node)`
`protected NettyTransport.NodeChannels`	`connectToChannelsLight(DiscoveryNode node)`
`void`	`connectToNode(DiscoveryNode node)` Connects to the given node, if already connected, does nothing.
`void`	`connectToNode(DiscoveryNode node, boolean light)`
`void`	`connectToNodeLight(DiscoveryNode node)` Connects to a node in a light manner.
`void`	`disconnectFromNode(DiscoveryNode node)` Disconnected from the given node, if not connected, will do nothing.
`protected boolean`	`disconnectFromNode(DiscoveryNode node, Channel channel, String reason)` Disconnects from a node, only if the relevant channel is found to be part of the node channels.
`protected void`	`disconnectFromNodeChannel(Channel channel, Throwable failure)` Disconnects from a node if a channel is found as part of that nodes channels.
`protected void`	`doClose()`
`protected void`	`doStart()`
`protected void`	`doStop()`
`protected void`	`exceptionCaught(ChannelHandlerContext ctx, ExceptionEvent e)`
`protected Channel`	`nodeChannel(DiscoveryNode node, TransportRequestOptions options)`
`boolean`	`nodeConnected(DiscoveryNode node)` Returns `true` if the node is connected.
`Map<String,BoundTransportAddress>`	`profileBoundAddresses()` Further profile bound addresses
`void`	`sendRequest(DiscoveryNode node, long requestId, String action, TransportRequest request, TransportRequestOptions options)` Sends the request to the node.
`long`	`serverOpen()` Returns count of currently open connections
`Settings`	`settings()`
`void`	`transportServiceAdapter(TransportServiceAdapter service)`

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class org.elasticsearch.common.component.AbstractComponent
nodeName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent
addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.elasticsearch.common.lease.Releasable
close

Field Detail

HTTP_SERVER_WORKER_THREAD_NAME_PREFIX

public static final String HTTP_SERVER_WORKER_THREAD_NAME_PREFIX

See Also:: Constant Field Values

HTTP_SERVER_BOSS_THREAD_NAME_PREFIX

public static final String HTTP_SERVER_BOSS_THREAD_NAME_PREFIX

See Also:: Constant Field Values

TRANSPORT_CLIENT_WORKER_THREAD_NAME_PREFIX

public static final String TRANSPORT_CLIENT_WORKER_THREAD_NAME_PREFIX

See Also:: Constant Field Values

TRANSPORT_CLIENT_BOSS_THREAD_NAME_PREFIX

public static final String TRANSPORT_CLIENT_BOSS_THREAD_NAME_PREFIX

See Also:: Constant Field Values

WORKER_COUNT

public static final String WORKER_COUNT

See Also:: Constant Field Values

CONNECTIONS_PER_NODE_RECOVERY

public static final String CONNECTIONS_PER_NODE_RECOVERY

See Also:: Constant Field Values

CONNECTIONS_PER_NODE_BULK

public static final String CONNECTIONS_PER_NODE_BULK

See Also:: Constant Field Values

CONNECTIONS_PER_NODE_REG

public static final String CONNECTIONS_PER_NODE_REG

See Also:: Constant Field Values

CONNECTIONS_PER_NODE_STATE

public static final String CONNECTIONS_PER_NODE_STATE

See Also:: Constant Field Values

CONNECTIONS_PER_NODE_PING

public static final String CONNECTIONS_PER_NODE_PING

See Also:: Constant Field Values

PING_SCHEDULE

public static final String PING_SCHEDULE

See Also:: Constant Field Values

DEFAULT_PING_SCHEDULE

public static final TimeValue DEFAULT_PING_SCHEDULE

DEFAULT_PORT_RANGE

public static final String DEFAULT_PORT_RANGE

See Also:: Constant Field Values

DEFAULT_PROFILE

public static final String DEFAULT_PROFILE

See Also:: Constant Field Values

networkService

protected final NetworkService networkService

version
```
protected final Version version
```

blockingClient
```
protected final boolean blockingClient
```

connectTimeout

protected final TimeValue connectTimeout

maxCumulationBufferCapacity

protected final ByteSizeValue maxCumulationBufferCapacity

maxCompositeBufferComponents

protected final int maxCompositeBufferComponents

compress
```
protected final boolean compress
```

receiveBufferSizePredictorFactory

protected final ReceiveBufferSizePredictorFactory receiveBufferSizePredictorFactory

workerCount
```
protected final int workerCount
```

receivePredictorMin

protected final ByteSizeValue receivePredictorMin

receivePredictorMax

protected final ByteSizeValue receivePredictorMax

connectionsPerNodeRecovery

protected final int connectionsPerNodeRecovery

connectionsPerNodeBulk

protected final int connectionsPerNodeBulk

connectionsPerNodeReg

protected final int connectionsPerNodeReg

connectionsPerNodeState

protected final int connectionsPerNodeState

connectionsPerNodePing

protected final int connectionsPerNodePing

bigArrays
```
protected final BigArrays bigArrays
```

threadPool
```
protected final ThreadPool threadPool
```

serverOpenChannels

protected volatile OpenChannelsHandler serverOpenChannels

clientBootstrap

protected volatile ClientBootstrap clientBootstrap

connectedNodes

protected final ConcurrentMap<DiscoveryNode,NettyTransport.NodeChannels> connectedNodes

serverBootstraps

protected final Map<String,ServerBootstrap> serverBootstraps

serverChannels

protected final Map<String,Channel> serverChannels

profileBoundAddresses

protected final Map<String,BoundTransportAddress> profileBoundAddresses

transportServiceAdapter

protected volatile TransportServiceAdapter transportServiceAdapter

boundAddress

protected volatile BoundTransportAddress boundAddress

connectionLock

protected final KeyedLock<String> connectionLock

Constructor Detail

NettyTransport

@Inject
public NettyTransport(Settings settings,
                              ThreadPool threadPool,
                              NetworkService networkService,
                              BigArrays bigArrays,
                              Version version)

Method Detail

settings
```
public Settings settings()
```

transportServiceAdapter

public void transportServiceAdapter(TransportServiceAdapter service)

doStart
```
protected void doStart()
                throws ElasticsearchException
```
Specified by:

doStart in class AbstractLifecycleComponent<Transport>

Throws:

ElasticsearchException

profileBoundAddresses
```
public Map<String,BoundTransportAddress> profileBoundAddresses()
```
Description copied from interface: Transport

Further profile bound addresses

Specified by:

profileBoundAddresses in interface Transport

Returns:

Should return null if transport does not support profiles, otherwise a map with name of profile and its bound transport address

doStop
```
protected void doStop()
               throws ElasticsearchException
```
Specified by:

doStop in class AbstractLifecycleComponent<Transport>

Throws:

ElasticsearchException

doClose
```
protected void doClose()
                throws ElasticsearchException
```
Specified by:

doClose in class AbstractLifecycleComponent<Transport>

Throws:

ElasticsearchException

addressesFromString
```
public TransportAddress[] addressesFromString(String address)
                                       throws Exception
```
Description copied from interface: Transport

Returns an address from its string representation.

Specified by:

addressesFromString in interface Transport

Throws:

Exception

addressSupported
```
public boolean addressSupported(Class<? extends TransportAddress> address)
```
Description copied from interface: Transport

Is the address type supported.

boundAddress
```
public BoundTransportAddress boundAddress()
```
Description copied from interface: Transport

The address the transport is bound on.

exceptionCaught

protected void exceptionCaught(ChannelHandlerContext ctx,
                               ExceptionEvent e)
                        throws Exception

Throws:: Exception

serverOpen
```
public long serverOpen()
```
Description copied from interface: Transport

Returns count of currently open connections

sendRequest

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

Description copied from interface: Transport

Sends the request to the node.

Specified by:: sendRequest in interface Transport
Throws:: IOException; TransportException

nodeConnected
```
public boolean nodeConnected(DiscoveryNode node)
```
Description copied from interface: Transport

Returns true if the node is connected.

connectToNodeLight
```
public void connectToNodeLight(DiscoveryNode node)
                        throws ConnectTransportException
```
Description copied from interface: Transport

Connects to a node in a light manner. Used when just connecting for ping and then disconnecting.

Specified by:

connectToNodeLight in interface Transport

Throws:

ConnectTransportException

connectToNode
```
public void connectToNode(DiscoveryNode node)
```
Description copied from interface: Transport

Connects to the given node, if already connected, does nothing.

connectToNode

public void connectToNode(DiscoveryNode node,
                          boolean light)

connectToChannelsLight

protected NettyTransport.NodeChannels connectToChannelsLight(DiscoveryNode node)

connectToChannels

protected void connectToChannels(NettyTransport.NodeChannels nodeChannels,
                                 DiscoveryNode node)

disconnectFromNode
```
public void disconnectFromNode(DiscoveryNode node)
```
Description copied from interface: Transport

Disconnected from the given node, if not connected, will do nothing.

disconnectFromNode

protected boolean disconnectFromNode(DiscoveryNode node,
                                     Channel channel,
                                     String reason)

Disconnects from a node, only if the relevant channel is found to be part of the node channels.

disconnectFromNodeChannel

protected void disconnectFromNodeChannel(Channel channel,
                                         Throwable failure)

Disconnects from a node if a channel is found as part of that nodes channels.

nodeChannel

protected Channel nodeChannel(DiscoveryNode node,
                              TransportRequestOptions options)
                       throws ConnectTransportException

Throws:: ConnectTransportException

configureClientChannelPipelineFactory

public ChannelPipelineFactory configureClientChannelPipelineFactory()

configureServerChannelPipelineFactory

public ChannelPipelineFactory configureServerChannelPipelineFactory(String name,
                                                                    Settings settings)

Class NettyTransport

Nested Class Summary

Nested Classes

Nested classes/interfaces inherited from interface org.elasticsearch.transport.Transport

Field Summary

Fields

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

Constructor Summary

Constructors

Method Summary

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent

Methods inherited from interface org.elasticsearch.common.lease.Releasable

Field Detail

HTTP_SERVER_WORKER_THREAD_NAME_PREFIX

HTTP_SERVER_BOSS_THREAD_NAME_PREFIX

TRANSPORT_CLIENT_WORKER_THREAD_NAME_PREFIX

TRANSPORT_CLIENT_BOSS_THREAD_NAME_PREFIX

WORKER_COUNT

CONNECTIONS_PER_NODE_RECOVERY

CONNECTIONS_PER_NODE_BULK

CONNECTIONS_PER_NODE_REG

CONNECTIONS_PER_NODE_STATE

CONNECTIONS_PER_NODE_PING

PING_SCHEDULE

DEFAULT_PING_SCHEDULE

DEFAULT_PORT_RANGE

DEFAULT_PROFILE

networkService

version

blockingClient

connectTimeout

maxCumulationBufferCapacity

maxCompositeBufferComponents

compress

receiveBufferSizePredictorFactory

workerCount

receivePredictorMin

receivePredictorMax

connectionsPerNodeRecovery

connectionsPerNodeBulk

connectionsPerNodeReg

connectionsPerNodeState

connectionsPerNodePing

bigArrays

threadPool

serverOpenChannels

clientBootstrap

connectedNodes

serverBootstraps

serverChannels

profileBoundAddresses

transportServiceAdapter

boundAddress

connectionLock

Constructor Detail

NettyTransport

Method Detail

settings

transportServiceAdapter

doStart

profileBoundAddresses

doStop

doClose

addressesFromString

addressSupported

boundAddress

exceptionCaught

serverOpen

sendRequest

nodeConnected

connectToNodeLight

connectToNode

connectToNode

connectToChannelsLight

connectToChannels

disconnectFromNode