software.amazon.awssdk.eventstreamrpc

Class OperationResponse<ResponseType extends EventStreamJsonMessage,StreamRequestType extends EventStreamJsonMessage>

java.lang.Object

software.amazon.awssdk.eventstreamrpc.OperationResponse<ResponseType,StreamRequestType>

Type Parameters:

ResponseType -

StreamRequestType -

All Implemented Interfaces:

AutoCloseable, StreamEventPublisher<StreamRequestType>, StreamResponse<ResponseType,StreamRequestType>

public class OperationResponse<ResponseType extends EventStreamJsonMessage,StreamRequestType extends EventStreamJsonMessage>
extends Object
implements StreamResponse<ResponseType,StreamRequestType>, AutoCloseable

Underlying type for operation response handling. Enables publishing on stream operations from client, closing of any open stream, and retrieval of response. Specific generated operation response handlers are usually simple wrappers with the generic types specified

Constructor Summary

Constructors

Constructor and Description
OperationResponse(OperationModelContext<ResponseType,?,StreamRequestType,?> operationModelContext, software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation continuation, CompletableFuture<ResponseType> responseFuture, CompletableFuture<Void> requestFlushFuture)

Method Summary

Modifier and Type	Method and Description
void	close()
CompletableFuture<Void>	closeStream() Initiate a close on the event stream from the client side.
CompletableFuture<Void>	getRequestFlushFuture() Completable future indicating flush of the request that initiated the stream operation
CompletableFuture<ResponseType>	getResponse() Get the response completable future to wait on the initial response if there is one.
boolean	isClosed() Checks if the stream is closed
CompletableFuture<Void>	sendStreamEvent(StreamRequestType streamEvent) Publish stream events on an open operation's event stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationResponse

public OperationResponse(OperationModelContext<ResponseType,?,StreamRequestType,?> operationModelContext,
                         software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation continuation,
                         CompletableFuture<ResponseType> responseFuture,
                         CompletableFuture<Void> requestFlushFuture)

Method Detail

getRequestFlushFuture

public final CompletableFuture<Void> getRequestFlushFuture()

Description copied from interface: StreamResponse

Completable future indicating flush of the request that initiated the stream operation

Specified by:

getRequestFlushFuture in interface StreamResponse<ResponseType extends EventStreamJsonMessage,StreamRequestType extends EventStreamJsonMessage>

Returns:

getResponse

public CompletableFuture<ResponseType> getResponse()

Get the response completable future to wait on the initial response if there is one. May throw exception if requestFlushFuture throws an exception and will block if requestFlush has not completed.

Specified by:

getResponse in interface StreamResponse<ResponseType extends EventStreamJsonMessage,StreamRequestType extends EventStreamJsonMessage>

Returns:

sendStreamEvent

public CompletableFuture<Void> sendStreamEvent(StreamRequestType streamEvent)

Publish stream events on an open operation's event stream.

Specified by:

sendStreamEvent in interface StreamEventPublisher<StreamRequestType extends EventStreamJsonMessage>

Parameters:

streamEvent - event to publish

Returns:

Completable future indicating flush of the event over the stream

closeStream

public CompletableFuture<Void> closeStream()

Initiate a close on the event stream from the client side.

Specified by:

closeStream in interface StreamEventPublisher<StreamRequestType extends EventStreamJsonMessage>

Returns:

isClosed

public boolean isClosed()

Checks if the stream is closed

Specified by:

isClosed in interface StreamResponse<ResponseType extends EventStreamJsonMessage,StreamRequestType extends EventStreamJsonMessage>

Returns:

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception