software.amazon.awssdk.eventstreamrpc.StreamResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-iot-device-sdk Show documentation

Java bindings for the AWS IoT Core Service

There is a newer version: 1.23.0

/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

package software.amazon.awssdk.eventstreamrpc;

import software.amazon.awssdk.eventstreamrpc.model.EventStreamJsonMessage;

import java.util.concurrent.CompletableFuture;

/**
 * Interface for stream responses
 */
public interface StreamResponse
                        extends StreamEventPublisher {
    /**
     * Completable future indicating flush of the request that initiated the stream operation
     *
     * @return Completable future indicating flush of the request that initiated the stream operation
     */
    CompletableFuture getRequestFlushFuture();

    /**
     * Completable future for retrieving the initial-response of the stream operation
     *
     * @return Completable future for retrieving the initial-response of the stream operation
     */
    CompletableFuture getResponse();

    /**
     * Tests if the stream is closed
     * @return True if the stream is closed
     */
    boolean isClosed();
}