eventstreamapi

Documentation

Index

• Constants
• func AddInitializeStreamWriter(stack *middleware.Stack) error
• func ApplyHTTPTransportFixes(r *smithyhttp.Request) error
• func GetInputStreamWriter(ctx context.Context) io.WriteCloser
• type InitializeStreamWriter
  • func (i *InitializeStreamWriter) HandleFinalize(ctx context.Context, in middleware.FinalizeInput, ...) (out middleware.FinalizeOutput, metadata middleware.Metadata, err error)
  • func (i *InitializeStreamWriter) ID() string

Constants

const (
	ChunkSignatureHeader = `:chunk-signature` // chunk signature for message
	DateHeader           = `:date`            // Date header for signature
	ContentTypeHeader    = ":content-type"    // message payload content-type

	// Message header and values
	MessageTypeHeader    = `:message-type` // Identifies type of message.
	EventMessageType     = `event`
	ErrorMessageType     = `error`
	ExceptionMessageType = `exception`

	// Message Events
	EventTypeHeader = `:event-type` // Identifies message event type e.g. "Stats".

	// Message Error
	ErrorCodeHeader    = `:error-code`
	ErrorMessageHeader = `:error-message`

	// Message Exception
	ExceptionTypeHeader = `:exception-type`
)

EventStream headers with specific meaning to async API functionality.

Functions

func AddInitializeStreamWriter

func AddInitializeStreamWriter(stack *middleware.Stack) error

AddInitializeStreamWriter adds the InitializeStreamWriter middleware to the provided stack.

func ApplyHTTPTransportFixes

func ApplyHTTPTransportFixes(r *smithyhttp.Request) error

ApplyHTTPTransportFixes applies fixes to the HTTP request for proper event stream functionality.

This operation is a no-op for Go 1.18 and above.

func GetInputStreamWriter

func GetInputStreamWriter(ctx context.Context) io.WriteCloser

GetInputStreamWriter returns EventTypeHeader io.PipeWriter used for the operation's input event stream.

Types

type InitializeStreamWriter

type InitializeStreamWriter struct{}

InitializeStreamWriter is a Finalize middleware initializes an in-memory pipe for sending event stream messages via the HTTP request body.

func (*InitializeStreamWriter) HandleFinalize

func (i *InitializeStreamWriter) HandleFinalize(
	ctx context.Context, in middleware.FinalizeInput, next middleware.FinalizeHandler,
) (
	out middleware.FinalizeOutput, metadata middleware.Metadata, err error,
)

HandleFinalize is the middleware implementation.

func (*InitializeStreamWriter) ID

func (i *InitializeStreamWriter) ID() string

ID returns the identifier for the middleware.