Module org.elasticsearch.compute

Package org.elasticsearch.compute.operator

Class SideChannel

java.lang.Object

org.elasticsearch.core.AbstractRefCounted

org.elasticsearch.compute.operator.SideChannel

All Implemented Interfaces:

Closeable, AutoCloseable, RefCounted, Releasable

Direct Known Subclasses:

SharedMinCompetitive, SharedNumericThreshold

public abstract class SideChannel
extends AbstractRefCounted
implements Releasable

A "side channel" for the Operators running on one node. These nodes must run on the same JVM, but will not run in the same Driver.

SideChannels are RefCounted so they can release resources when the last Operator referencing them is Operator.close()d.

SideChannels are configured during physical planning. And the physical plan nodes are not RefCounted. So we can't make the actual SideChannel implementations during planning. Instead, we configure a supplier that builds the SideChannel when building the first Operator instance.

This implements Releasable as a convenience that delegates to AbstractRefCounted.decRef().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SideChannel.Status
static class	SideChannel.Supplier<T extends SideChannel>	Builds the SideChannel on first use and returns a shared reference on the next use.

Field Summary

Fields inherited from class org.elasticsearch.core.AbstractRefCounted

ALREADY_CLOSED_MESSAGE, INVALID_DECREF_MESSAGE

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SideChannel(SideChannel.Supplier<?> mySupplier)

Method Summary

Modifier and Type	Method	Description
final void	close()
protected final void	closeInternal()
protected abstract void	closeSideChannel()

Methods inherited from class org.elasticsearch.core.AbstractRefCounted

alreadyClosed, decRef, hasReferences, incRef, mustIncRef, of, refCount, touch, tryIncRef

Methods inherited from class java.lang.Object

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

Constructor Details

SideChannel

protected SideChannel(SideChannel.Supplier<?> mySupplier)

Method Details

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

closeInternal

protected final void closeInternal()

Specified by:

closeInternal in class AbstractRefCounted

closeSideChannel

protected abstract void closeSideChannel()