java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.transport.TcpTransport

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, Transport

public abstract class TcpTransport
extends AbstractLifecycleComponent
implements Transport

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`TcpTransport.HttpRequestOnTransportException`	A helper exception to mark an incoming connection as potentially being HTTP so an appropriate error code can be returned
`class`	`TcpTransport.NodeChannels`
`static class`	`TcpTransport.ProfileSettings`	Representation of a transport profile settings for a `transport.profiles.$profilename.*`

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

Transport.Connection, Transport.ResponseContext<T extends TransportResponse>, Transport.ResponseHandlers

Field Summary

Fields
Modifier and Type	Field	Description
`protected NetworkService`	`networkService`
`protected PageCacheRecycler`	`pageCacheRecycler`
`protected java.util.Set<TcpTransport.ProfileSettings>`	`profileSettings`
`protected Settings`	`settings`
`protected ThreadPool`	`threadPool`
`static java.lang.String`	`TRANSPORT_WORKER_THREAD_NAME_PREFIX`

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

lifecycle

Constructor Summary

Constructors
Constructor	Description
`TcpTransport(Settings settings, Version version, ThreadPool threadPool, PageCacheRecycler pageCacheRecycler, CircuitBreakerService circuitBreakerService, NamedWriteableRegistry namedWriteableRegistry, NetworkService networkService)`

Method Summary

Modifier and Type	Method	Description
`TransportAddress[]`	`addressesFromString(java.lang.String address)`	Returns an address from its string representation.
`protected abstract TcpServerChannel`	`bind(java.lang.String name, java.net.InetSocketAddress address)`	Binds to the given `InetSocketAddress`
`protected void`	`bindServer(TcpTransport.ProfileSettings profileSettings)`
`BoundTransportAddress`	`boundAddress()`	The address the transport is bound on.
`int`	`consumeNetworkReads(TcpChannel channel, BytesReference bytesReference)`	Consumes bytes that are available from network reads.
`protected void`	`doClose()`
`protected void`	`doStart()`
`protected void`	`doStop()`
`void`	`executeHandshake(DiscoveryNode node, TcpChannel channel, ConnectionProfile profile, ActionListener<Version> listener)`
`java.util.List<java.lang.String>`	`getDefaultSeedAddresses()`	Returns a list of all local addresses for this transport
`static java.util.Set<TcpTransport.ProfileSettings>`	`getProfileSettings(Settings settings)`	Returns all profile settings for the given settings object
`RequestHandlerRegistry<? extends TransportRequest>`	`getRequestHandler(java.lang.String action)`	Returns the registered request handler registry for the given action or `null` if it's not registered
`Transport.ResponseHandlers`	`getResponseHandlers()`
`TransportStats`	`getStats()`
`void`	`inboundMessage(TcpChannel channel, BytesReference message)`	Handles inbound message that has been decoded.
`protected abstract TcpChannel`	`initiateChannel(DiscoveryNode node)`	Initiate a single tcp socket channel.
`protected ConnectionProfile`	`maybeOverrideConnectionProfile(ConnectionProfile connectionProfile)`
`void`	`onException(TcpChannel channel, java.lang.Exception e)`
`protected void`	`onServerException(TcpServerChannel channel, java.lang.Exception e)`
`void`	`openConnection(DiscoveryNode node, ConnectionProfile profile, ActionListener<Transport.Connection> listener)`	Opens a new connection to the given node.
`java.util.Map<java.lang.String,BoundTransportAddress>`	`profileBoundAddresses()`	Further profile bound addresses
`static int`	`readMessageLength(BytesReference networkBytes)`	Validates the first 6 bytes of the message header and returns the length of the message.
`<Request extends TransportRequest> void`	`registerRequestHandler(RequestHandlerRegistry<Request> reg)`	Registers a new request handler
`protected void`	`serverAcceptedChannel(TcpChannel channel)`
`void`	`setMessageListener(TransportMessageListener listener)`
`protected abstract void`	`stopInternal()`	Called to tear down internal resources

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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 Details
- TRANSPORT_WORKER_THREAD_NAME_PREFIX
  
  public static final java.lang.String TRANSPORT_WORKER_THREAD_NAME_PREFIX
  
  See Also:
  
  Constant Field Values
- settings
  
  protected final Settings settings
- threadPool
  
  protected final ThreadPool threadPool
- pageCacheRecycler
  
  protected final PageCacheRecycler pageCacheRecycler
- networkService
  
  protected final NetworkService networkService
- profileSettings
  
  protected final java.util.Set<TcpTransport.ProfileSettings> profileSettings
Constructor Details
- TcpTransport
  
  public TcpTransport(Settings settings, Version version, ThreadPool threadPool, PageCacheRecycler pageCacheRecycler, CircuitBreakerService circuitBreakerService, NamedWriteableRegistry namedWriteableRegistry, NetworkService networkService)
Method Details
- doStart
  
  protected void doStart()
  
  Specified by:
  
  doStart in class AbstractLifecycleComponent
- setMessageListener
  
  public void setMessageListener(TransportMessageListener listener)
  
  Specified by:
  
  setMessageListener in interface Transport
- registerRequestHandler
  
  public <Request extends TransportRequest> void registerRequestHandler(RequestHandlerRegistry<Request> reg)
  
  Description copied from interface: Transport
  
  Registers a new request handler
  
  Specified by:
  
  registerRequestHandler in interface Transport
- maybeOverrideConnectionProfile
  
  protected ConnectionProfile maybeOverrideConnectionProfile(ConnectionProfile connectionProfile)
- openConnection
  
  public void openConnection(DiscoveryNode node, ConnectionProfile profile, ActionListener<Transport.Connection> listener)
  
  Description copied from interface: Transport
  
  Opens a new connection to the given node. When the connection is fully connected, the listener is called. The ActionListener will be called on the calling thread or the generic thread pool.
  
  Specified by:
  
  openConnection in interface Transport
- boundAddress
  
  public BoundTransportAddress boundAddress()
  
  Description copied from interface: Transport
  
  The address the transport is bound on.
  
  Specified by:
  
  boundAddress in interface Transport
- profileBoundAddresses
  
  public java.util.Map<java.lang.String,BoundTransportAddress> profileBoundAddresses()
  
  Description copied from interface: Transport
  
  Further profile bound addresses
  
  Specified by:
  
  profileBoundAddresses in interface Transport
  
  Returns:
  
  null iff profiles are unsupported, otherwise a map with name of profile and its bound transport address
- getDefaultSeedAddresses
  
  public java.util.List<java.lang.String> getDefaultSeedAddresses()
  
  Description copied from interface: Transport
  
  Returns a list of all local addresses for this transport
  
  Specified by:
  
  getDefaultSeedAddresses in interface Transport
- bindServer
  
  protected void bindServer(TcpTransport.ProfileSettings profileSettings)
- addressesFromString
  
  public TransportAddress[] addressesFromString(java.lang.String address) throws java.net.UnknownHostException
  
  Description copied from interface: Transport
  
  Returns an address from its string representation.
  
  Specified by:
  
  addressesFromString in interface Transport
  
  Throws:
  
  java.net.UnknownHostException
- doClose
  
  protected final void doClose()
  
  Specified by:
  
  doClose in class AbstractLifecycleComponent
- doStop
  
  protected final void doStop()
  
  Specified by:
  
  doStop in class AbstractLifecycleComponent
- onException
  
  public void onException(TcpChannel channel, java.lang.Exception e)
- onServerException
  
  protected void onServerException(TcpServerChannel channel, java.lang.Exception e)
- serverAcceptedChannel
  
  protected void serverAcceptedChannel(TcpChannel channel)
- bind
  
  protected abstract TcpServerChannel bind(java.lang.String name, java.net.InetSocketAddress address) throws java.io.IOException
  
  Binds to the given InetSocketAddress
  
  Parameters:
  
  name - the profile name
  
  address - the address to bind to
  
  Throws:
  
  java.io.IOException
- initiateChannel
  
  protected abstract TcpChannel initiateChannel(DiscoveryNode node) throws java.io.IOException
  
  Initiate a single tcp socket channel.
  
  Parameters:
  
  node - for the initiated connection
  
  Returns:
  
  the pending connection
  
  Throws:
  
  java.io.IOException - if an I/O exception occurs while opening the channel
- stopInternal
  
  protected abstract void stopInternal()
  
  Called to tear down internal resources
- inboundMessage
  
  public void inboundMessage(TcpChannel channel, BytesReference message)
  
  Handles inbound message that has been decoded.
  
  Parameters:
  
  channel - the channel the message is from
  
  message - the message
- consumeNetworkReads
  
  public int consumeNetworkReads(TcpChannel channel, BytesReference bytesReference) throws java.io.IOException
  
  Consumes bytes that are available from network reads. This method returns the number of bytes consumed in this call.
  
  Parameters:
  
  channel - the channel read from
  
  bytesReference - the bytes available to consume
  
  Returns:
  
  the number of bytes consumed
  
  Throws:
  
  java.io.StreamCorruptedException - if the message header format is not recognized
  
  TcpTransport.HttpRequestOnTransportException - if the message header appears to be an HTTP message
  
  java.lang.IllegalArgumentException - if the message length is greater that the maximum allowed frame size. This is dependent on the available memory.
  
  java.io.IOException
- readMessageLength
  
  public static int readMessageLength(BytesReference networkBytes) throws java.io.IOException
  
  Validates the first 6 bytes of the message header and returns the length of the message. If 6 bytes are not available, it returns -1.
  
  Parameters:
  
  networkBytes - the will be read
  
  Returns:
  
  the length of the message
  
  Throws:
  
  java.io.StreamCorruptedException - if the message header format is not recognized
  
  TcpTransport.HttpRequestOnTransportException - if the message header appears to be an HTTP message
  
  java.lang.IllegalArgumentException - if the message length is greater that the maximum allowed frame size. This is dependent on the available memory.
  
  java.io.IOException
- executeHandshake
  
  public void executeHandshake(DiscoveryNode node, TcpChannel channel, ConnectionProfile profile, ActionListener<Version> listener)
- getStats
  
  public final TransportStats getStats()
  
  Specified by:
  
  getStats in interface Transport
- getProfileSettings
  
  public static java.util.Set<TcpTransport.ProfileSettings> getProfileSettings(Settings settings)
  
  Returns all profile settings for the given settings object
- getResponseHandlers
  
  public final Transport.ResponseHandlers getResponseHandlers()
  
  Specified by:
  
  getResponseHandlers in interface Transport
- getRequestHandler
  
  public final RequestHandlerRegistry<? extends TransportRequest> getRequestHandler(java.lang.String action)
  
  Description copied from interface: Transport
  
  Returns the registered request handler registry for the given action or null if it's not registered
  
  Specified by:
  
  getRequestHandler in interface Transport
  
  Parameters:
  
  action - the action to look up

Class TcpTransport