Package 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:
AuthorizeClientDeviceActionResponseHandler, CancelLocalDeploymentResponseHandler, CreateDebugPasswordResponseHandler, CreateLocalDeploymentResponseHandler, DeferComponentUpdateResponseHandler, DeleteThingShadowResponseHandler, GetClientDeviceAuthTokenResponseHandler, GetComponentDetailsResponseHandler, GetConfigurationResponseHandler, GetLocalDeploymentStatusResponseHandler, GetSecretValueResponseHandler, GetThingShadowResponseHandler, ListComponentsResponseHandler, ListLocalDeploymentsResponseHandler, ListNamedShadowsForThingResponseHandler, OperationResponse, PauseComponentResponseHandler, PublishToIoTCoreResponseHandler, PublishToTopicResponseHandler, PutComponentMetricResponseHandler, RestartComponentResponseHandler, ResumeComponentResponseHandler, SendConfigurationValidityReportResponseHandler, StopComponentResponseHandler, SubscribeToCertificateUpdatesResponseHandler, SubscribeToComponentUpdatesResponseHandler, SubscribeToConfigurationUpdateResponseHandler, SubscribeToIoTCoreResponseHandler, SubscribeToTopicResponseHandler, SubscribeToValidateConfigurationUpdatesResponseHandler, UpdateConfigurationResponseHandler, UpdateStateResponseHandler, UpdateThingShadowResponseHandler, ValidateAuthorizationTokenResponseHandler, VerifyClientDeviceIdentityResponseHandler
public interface StreamEventPublisher<StreamEventType extends EventStreamJsonMessage>
Interface to enable sending events over an open stream operation.

  • Method Details

    • 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