Module org.elasticsearch.server

Package org.elasticsearch.search.fetch.chunk

Class FetchPhaseResponseChunk

java.lang.Object

org.elasticsearch.search.fetch.chunk.FetchPhaseResponseChunk

All Implemented Interfaces:

Closeable, AutoCloseable, Writeable, Releasable

public class FetchPhaseResponseChunk
extends Object
implements Writeable, Releasable

A single chunk of fetch results streamed from a data node to the coordinator. Contains sequence information to maintain correct ordering when chunks arrive out of order.

Supports zero-copy transport by separating header metadata from serialized hits. The header is created after hits are serialized (since we don't know hit count until the buffer is full), then combined using CompositeBytesReference to avoid copying.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FetchPhaseResponseChunk.Writer	Interface for sending chunk responses from the data node to the coordinator.

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

Writeable.Reader<V>

Constructor Summary

Constructors

Constructor	Description
FetchPhaseResponseChunk(StreamInput in)	Deserializes from stream (receiving side).
FetchPhaseResponseChunk(ShardId shardId, BytesReference serializedHits, int hitCount, int expectedTotalDocs, long sequenceStart)	Creates a chunk with pre-serialized hits.

Method Summary

Modifier and Type	Method	Description
void	close()
int	expectedTotalDocs()
long	getBytesLength()
int[]	getHitPositions()
SearchHit[]	getHits()
int	hitCount()
long	sequenceStart()
ShardId	shardId()
ReleasableBytesReference	toReleasableBytesReference(long coordinatingTaskId)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Details

FetchPhaseResponseChunk

public FetchPhaseResponseChunk(ShardId shardId,
 BytesReference serializedHits,
 int hitCount,
 int expectedTotalDocs,
 long sequenceStart)

Creates a chunk with pre-serialized hits. Takes ownership of serializedHits - caller must not release it.

Parameters:

shardId - source shard

serializedHits - pre-serialized hit bytes

hitCount - number of hits in the serialized bytes

expectedTotalDocs - total number of documents requested for this shard fetch operation across all chunks (derived from requested doc IDs, not an observed count of docs received so far)

sequenceStart - sequence number of first hit for ordering

FetchPhaseResponseChunk

public FetchPhaseResponseChunk(StreamInput in)
                        throws IOException

Deserializes from stream (receiving side).

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toReleasableBytesReference

public ReleasableBytesReference toReleasableBytesReference(long coordinatingTaskId)
                                                    throws IOException

Throws:

IOException

getBytesLength

public long getBytesLength()

getHits

public SearchHit[] getHits()
                    throws IOException

Throws:

IOException

getHitPositions

public int[] getHitPositions()

shardId

public ShardId shardId()

hitCount

public int hitCount()

expectedTotalDocs

public int expectedTotalDocs()

sequenceStart

public long sequenceStart()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable