Package: eventstream

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

Sub-Packages

eventstreamapi

Type Summary

• BoolValue struct

  Get returns the underlying type.

• BytesValue struct

  Get returns the underlying value.

• ChecksumError struct
• Decoder struct

  Decoder provides decoding of an Event Stream messages.

• DecoderOptions struct

  DecoderOptions is the Decoder configuration options.

• Encoder struct

  Encoder provides EventStream message encoding.

• EncoderOptions struct

  EncoderOptions is the configuration options for Encoder.

• Header struct

  Header is a single EventStream Key Value header pair.

• Headers struct

  Set associates the name with a value.

• Int16Value struct

  Get returns the underlying value.

• Int32Value struct

  Get returns the underlying value.

• Int64Value struct

  Get returns the underlying value.

• Int8Value struct

  Get returns the underlying value.

• LengthError struct

  LengthError provides the error for items being larger than a maximum length.

• Message struct

  A Message provides the eventstream message representation.

• StringValue struct

  Get returns the underlying value.

• TimestampValue struct

  Get returns the underlying value.

• UUIDValue struct

  Get returns the underlying value.

Interface Summary

• Value interface

  Value represents the abstract header value.

Function Summary

• func EncodeHeaders(w io.Writer, headers Headers) error

  EncodeHeaders writes the header values to the writer encoded in the event stream format.

• func NewDecoder(optFns ...func(*DecoderOptions)) *Decoder

  NewDecoder initializes and returns a Decoder for decoding event stream messages from the reader provided.

• func NewEncoder(optFns ...func(*EncoderOptions)) *Encoder

  NewEncoder initializes and returns an Encoder to encode Event Stream messages.

Type Details

DecoderOptions struct

DecoderOptions is the Decoder configuration options.

Structure Fields:

Logger logging.Logger

LogMessages bool

EncoderOptions struct

EncoderOptions is the configuration options for Encoder.

Structure Fields:

Logger logging.Logger

LogMessages bool

Header struct

Header is a single EventStream Key Value header pair.

Structure Fields:

Name string

Value Value

Function Details

func EncodeHeaders(w io.Writer, headers Headers) error

EncodeHeaders writes the header values to the writer encoded in the event stream format. Returns an error if a header fails to encode.

// File 'aws/protocol/eventstream/encode.go', line 141

func EncodeHeaders(w io.Writer, headers Headers) error {
	for _, h := range headers {
		hn := headerName{
			Len: uint8(len(h.Name)),
		}
		copy(hn.Name[:hn.Len], h.Name)
		if err := hn.encode(w); err != nil {
			return err
		}

		if err := h.Value.encode(w); err != nil {
			return err
		}
	}

	return nil
}

func NewDecoder(optFns ...func(*DecoderOptions)) *Decoder

NewDecoder initializes and returns a Decoder for decoding event stream messages from the reader provided.

// File 'aws/protocol/eventstream/decode.go', line 27

func NewDecoder(optFns ...func(*DecoderOptions)) *Decoder {
	options := DecoderOptions{}

	for _, fn := range optFns {
		fn(&options)
	}

	return &Decoder{
		options: options,
	}
}

func NewEncoder(optFns ...func(*EncoderOptions)) *Encoder

NewEncoder initializes and returns an Encoder to encode Event Stream messages.

// File 'aws/protocol/eventstream/encode.go', line 30

func NewEncoder(optFns ...func(*EncoderOptions)) *Encoder {
	o := EncoderOptions{}

	for _, fn := range optFns {
		fn(&o)
	}

	return &Encoder{
		options:    o,
		headersBuf: bytes.NewBuffer(nil),
		messageBuf: bytes.NewBuffer(nil),
	}
}