org.elasticsearch.compute.operator.exchange.ExchangeSink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of x-pack-esql-compute Show documentation

Elasticsearch subproject :x-pack:plugin:esql:compute

There is a newer version: 8.16.1

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

package org.elasticsearch.compute.operator.exchange;

import org.elasticsearch.action.support.SubscribableListener;
import org.elasticsearch.compute.data.Page;

/**
 * Sink for exchanging data
 * @see ExchangeSinkOperator
 */
public interface ExchangeSink {
    /**
     * adds a new page to this sink
     */
    void addPage(Page page);

    /**
     * called once all pages have been added (see {@link #addPage(Page)}).
     */
    void finish();

    /**
     * Whether the sink has received all pages
     */
    boolean isFinished();

    /**
     * Whether the sink is blocked on adding more pages
     */
    SubscribableListener waitForWriting();
}