encoding

Documentation

Index

• Variables
• func RegisterCodec(codec Codec)
• type Codec
  • func GetCodec(contentSubtype string) (Codec, error)

Variables

var ErrUnknownCodec = errors.New("protoevent: unknown codec")

Functions

func RegisterCodec

func RegisterCodec(codec Codec)

RegisterCodec registers the provided Codec for use with all PubSub publishers and subscribers.

The Codec will be stored and looked up by result of its Name() method, which should match the content-subtype of the encoding handled by the Codec. This is case-insensitive, and is stored and looked up as lowercase. If the result of calling Name() is an empty string, RegisterCodec will panic.

NOTE: this function must only be called during initialization time (i.e. in an init() function), and is not thread-safe. If multiple Compressors are registered with the same name, the one registered last will take effect.

Types

type Codec

type Codec interface {
	// Name returns the name of the Codec implementation. The returned string
	// will be used as part of content type in transmission.  The result must be
	// static; the result cannot change between calls.
	Name() string
	// Marshal returns the wire format of v.
	Marshal(v interface{}) ([]byte, error)
	// Unmarshal parses the wire format into v.
	Unmarshal(data []byte, v interface{}) error
}

Codec defines the interface PubSub uses to encode and decode messages. Note that implementations of this interface must be thread safe; a Codec's methods can be called from concurrent goroutines.

func GetCodec

func GetCodec(contentSubtype string) (Codec, error)

GetCodec gets a registered Codec by content-subtype, or err if no Codec is registered for the content-subtype.

The content-subtype is expected to be lowercase.