software.amazon.awssdk.eventstreamrpc

Interface StreamEventPublisher<StreamEventType extends EventStreamJsonMessage>

Type Parameters:

StreamEventType - Data to push over the open stream

All Known Subinterfaces:

StreamResponse<ResponseType,StreamRequestType>

All Known Implementing Classes:

CreateDebugPasswordResponseHandler, CreateLocalDeploymentResponseHandler, DeferComponentUpdateResponseHandler, DeleteThingShadowResponseHandler, GetComponentDetailsResponseHandler, GetConfigurationResponseHandler, GetLocalDeploymentStatusResponseHandler, GetSecretValueResponseHandler, GetThingShadowResponseHandler, ListComponentsResponseHandler, ListLocalDeploymentsResponseHandler, ListNamedShadowsForThingResponseHandler, OperationResponse, PauseComponentResponseHandler, PublishToIoTCoreResponseHandler, PublishToTopicResponseHandler, RestartComponentResponseHandler, ResumeComponentResponseHandler, SendConfigurationValidityReportResponseHandler, StopComponentResponseHandler, SubscribeToComponentUpdatesResponseHandler, SubscribeToConfigurationUpdateResponseHandler, SubscribeToIoTCoreResponseHandler, SubscribeToTopicResponseHandler, SubscribeToValidateConfigurationUpdatesResponseHandler, UpdateConfigurationResponseHandler, UpdateStateResponseHandler, UpdateThingShadowResponseHandler, ValidateAuthorizationTokenResponseHandler

public interface StreamEventPublisher<StreamEventType extends EventStreamJsonMessage>

Interface to enable sending events over an open stream operation.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	closeStream() Closes the stream by sending an empty message
CompletableFuture<Void>	sendStreamEvent(StreamEventType streamEvent) Publish an event over an open stream operation.

Method Detail

sendStreamEvent

CompletableFuture<Void> sendStreamEvent(StreamEventType streamEvent)

Publish an event over an open stream operation.

Parameters:

streamEvent - event to publish

Returns:

Completable future indicating flush of the event over the stream

closeStream

CompletableFuture<Void> closeStream()

Closes the stream by sending an empty message

Returns:

Completable future indicating flush of the stream termination message