Package: eventstreamapi

import "../ibm-cos-sdk-go-v2/aws/protocol/eventstream/eventstreamapi"

Constants

const ChunkSignatureHeader = readonly

Value:

`:chunk-signature` // chunk signature for message

const DateHeader = readonly

Value:

`:date`            // Date header for signature

const ContentTypeHeader = readonly

Value:

":content-type"    // message payload content-type

const MessageTypeHeader = readonly

Message header and values

Value:

`:message-type` // Identifies type of message.

const EventMessageType = readonly

Value:

`event`

const ErrorMessageType = readonly

Value:

`error`

const ExceptionMessageType = readonly

Value:

`exception`

const EventTypeHeader = readonly

Message Events

Value:

`:event-type` // Identifies message event type e.g. "Stats".

const ErrorCodeHeader = readonly

Message Error

Value:

`:error-code`

const ErrorMessageHeader = readonly

Value:

`:error-message`

const ExceptionTypeHeader = readonly

Message Exception

Value:

`:exception-type`

Type Summary

• InitializeStreamWriter struct

  ID returns the identifier for the middleware.

Function Summary

• func AddInitializeStreamWriter(stack *middleware.Stack) error

  AddInitializeStreamWriter adds the InitializeStreamWriter middleware to the provided stack.

• func ApplyHTTPTransportFixes(r *smithyhttp.Request) error

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

• func GetInputStreamWriter(ctx context.Context) io.WriteCloser

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

Function Details

func AddInitializeStreamWriter(stack *middleware.Stack) error

AddInitializeStreamWriter adds the InitializeStreamWriter middleware to the provided stack.

// File 'aws/protocol/eventstream/eventstreamapi/middleware.go', line 27

func AddInitializeStreamWriter(stack *middleware.Stack) error {
	return stack.Finalize.Add(&InitializeStreamWriter{}, middleware.After)
}

func ApplyHTTPTransportFixes(r *smithyhttp.Request) error

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

// File 'aws/protocol/eventstream/eventstreamapi/transport.go', line 10

func ApplyHTTPTransportFixes(r *smithyhttp.Request) error {
	return nil
}

func GetInputStreamWriter(ctx context.Context) io.WriteCloser

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

// File 'aws/protocol/eventstream/eventstreamapi/middleware.go', line 13

func GetInputStreamWriter(ctx context.Context) io.WriteCloser {
	writeCloser, _ := middleware.GetStackValue(ctx, eventStreamWriterKey{}).(io.WriteCloser)
	return writeCloser
}