Module org.elasticsearch.server

Package org.elasticsearch.action.support.nodes

Class BaseNodeResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.support.nodes.BaseNodeResponse

All Implemented Interfaces:

Writeable, RefCounted

Direct Known Subclasses:

ClusterStatsNodeResponse, NodeFindDanglingIndexResponse, NodeHotThreads, NodeInfo, NodeListDanglingIndicesResponse, NodesReloadSecureSettingsResponse.NodeResponse, NodeStats, NodeUsage, TransportNodesListGatewayStartedShards.NodeGatewayStartedShards, TransportNodesListShardStoreMetadata.NodeStoreFilesMetadata, TransportNodesSnapshotsStatus.NodeSnapshotStatus

public abstract class BaseNodeResponse
extends TransportResponse

A base class for node level operations.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseNodeResponse(DiscoveryNode node)
protected	BaseNodeResponse(StreamInput in)	Read a response from the given stream, with no DiscoveryNode object re-use.
protected	BaseNodeResponse(StreamInput in, DiscoveryNode node)	Read a response from the given stream, re-using the given DiscoveryNode object if non-null.

Method Summary

Modifier and Type	Method	Description
DiscoveryNode	getNode()	The node this information relates to.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Constructor Details

BaseNodeResponse

protected BaseNodeResponse(StreamInput in,
 @Nullable
 DiscoveryNode node)
                    throws IOException

Read a response from the given stream, re-using the given DiscoveryNode object if non-null. On the wire a BaseNodeResponse message starts with a DiscoveryNode identifying the original responder. If the sender knows the identity of the responder already then we prefer to use that rather than reading the object from the wire, since DiscoveryNode objects are sometimes quite large and yet they're immutable so there's no need to have multiple copies in memory.

Parameters:

node - the expected remote node, or null if not known.

Throws:

IOException

BaseNodeResponse

protected BaseNodeResponse(StreamInput in)
                    throws IOException

Read a response from the given stream, with no DiscoveryNode object re-use. Callers should not use this constructor if the local node is known, and instead should call BaseNodeResponse(StreamInput, DiscoveryNode).

Throws:

IOException

BaseNodeResponse

protected BaseNodeResponse(DiscoveryNode node)

Method Details

getNode

public DiscoveryNode getNode()

The node this information relates to.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

IOException