Module org.elasticsearch.server

Package org.elasticsearch.transport

Class TransportMessage

java.lang.Object

org.elasticsearch.transport.TransportMessage

All Implemented Interfaces:

Writeable, RefCounted

Direct Known Subclasses:

TransportRequest, TransportResponse

public abstract class TransportMessage
extends Object
implements Writeable, RefCounted

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
TransportMessage()	Constructs a new empty transport message
TransportMessage(StreamInput in)	Constructs a new transport message with the data from the StreamInput.

Method Summary

Modifier and Type	Method	Description
boolean	decRef()	Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply.
boolean	hasReferences()
void	incRef()
InetSocketAddress	remoteAddress()
void	remoteAddress(InetSocketAddress remoteAddress)
boolean	tryIncRef()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Constructor Details

TransportMessage

public TransportMessage()

Constructs a new empty transport message

TransportMessage

public TransportMessage(StreamInput in)

Constructs a new transport message with the data from the StreamInput. This is currently a no-op

Method Details

remoteAddress

public void remoteAddress(InetSocketAddress remoteAddress)

remoteAddress

@Nullable
public InetSocketAddress remoteAddress()

incRef

public void incRef()

Specified by:

incRef in interface RefCounted

tryIncRef

public boolean tryIncRef()

Specified by:

tryIncRef in interface RefCounted

decRef

public boolean decRef()

Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply. When in doubt, dispatch any further work onto a separate thread.

Specified by:

decRef in interface RefCounted

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface RefCounted