codec

Documentation

Overview

Package codec is an interface for encoding messages

Index

• Variables
• func NewContext(ctx context.Context, c Codec) context.Context
• type Codec
  • func FromContext(ctx context.Context) (Codec, bool)
  • func NewCodec(opts ...Option) Codec
• type Frame
  • func (m *Frame) Marshal() ([]byte, error)
  • func (m *Frame) MarshalJSON() ([]byte, error)
  • func (m *Frame) ProtoMessage()
  • func (m *Frame) Reset()
  • func (m *Frame) String() string
  • func (m *Frame) Unmarshal(data []byte) error
  • func (m *Frame) UnmarshalJSON(data []byte) error
• type Message
  • func NewMessage(t MessageType) *Message
• type MessageType
• type Option
  • func Logger(l logger.Logger) Option
  • func MaxMsgSize(n int) Option
  • func Meter(m meter.Meter) Option
  • func SetOption(k, v interface{}) Option
  • func TagName(n string) Option
  • func Tracer(t tracer.Tracer) Option
• type Options
  • func NewOptions(opts ...Option) Options

Variables

var (
	// ErrInvalidMessage returned when invalid messge passed to codec
	ErrInvalidMessage = errors.New("invalid message")
	// ErrUnknownContentType returned when content-type is unknown
	ErrUnknownContentType = errors.New("unknown content-type")
)

var (
	// DefaultMaxMsgSize specifies how much data codec can handle
	DefaultMaxMsgSize = 1024 * 1024 * 4 // 4Mb
	// DefaultCodec is the global default codec
	DefaultCodec Codec = NewCodec()
	// DefaultTagName specifies struct tag name to control codec Marshal/Unmarshal
	DefaultTagName = "codec"
)

Functions

func NewContext

func NewContext(ctx context.Context, c Codec) context.Context

NewContext put codec in context

Types

type Codec

type Codec interface {
	ReadHeader(r io.Reader, m *Message, mt MessageType) error
	ReadBody(r io.Reader, v interface{}) error
	Write(w io.Writer, m *Message, v interface{}) error
	Marshal(v interface{}, opts ...Option) ([]byte, error)
	Unmarshal(b []byte, v interface{}, opts ...Option) error
	String() string
}

Codec encodes/decodes various types of messages used within micro. ReadHeader and ReadBody are called in pairs to read requests/responses from the connection. Close is called when finished with the connection. ReadBody may be called with a nil argument to force the body to be read and discarded.

func FromContext

func FromContext(ctx context.Context) (Codec, bool)

FromContext returns codec from context

func NewCodec

func NewCodec(opts ...Option) Codec

NewCodec returns new noop codec

type Frame

type Frame struct {
	Data []byte
}

Frame gives us the ability to define raw data to send over the pipes

func (*Frame) Marshal

func (m *Frame) Marshal() ([]byte, error)

func (*Frame) MarshalJSON

func (m *Frame) MarshalJSON() ([]byte, error)

func (*Frame) ProtoMessage

func (m *Frame) ProtoMessage()

func (*Frame) Reset

func (m *Frame) Reset()

func (*Frame) String

func (m *Frame) String() string

func (*Frame) Unmarshal

func (m *Frame) Unmarshal(data []byte) error

func (*Frame) UnmarshalJSON

func (m *Frame) UnmarshalJSON(data []byte) error

type Message

type Message struct {
	Header   metadata.Metadata
	Target   string
	Method   string
	Endpoint string
	Error    string
	Id       string
	Body     []byte
	Type     MessageType
}

Message represents detailed information about the communication, likely followed by the body. In the case of an error, body may be nil.

func NewMessage

func NewMessage(t MessageType) *Message

NewMessage creates new codec message

type MessageType

type MessageType int

MessageType specifies message type for codec

const (
	Error MessageType = iota
	Request
	Response
	Event
)

Message types

type Option

type Option func(*Options)

Option func

func Logger

func Logger(l logger.Logger) Option

Logger sets the logger

func MaxMsgSize

func MaxMsgSize(n int) Option

MaxMsgSize sets the max message size

func Meter

func Meter(m meter.Meter) Option

Meter sets the meter

func SetOption

func SetOption(k, v interface{}) Option

SetOption returns a function to setup a context with given value

func TagName

func TagName(n string) Option

TagName sets the codec tag name in struct

func Tracer

func Tracer(t tracer.Tracer) Option

Tracer to be used for tracing

type Options

type Options struct {
	// Meter used for metrics
	Meter meter.Meter
	// Logger used for logging
	Logger logger.Logger
	// Tracer used for tracing
	Tracer tracer.Tracer
	// Context stores additional codec options
	Context context.Context
	// TagName specifies tag name in struct to control codec
	TagName string
	// MaxMsgSize specifies max messages size that reads by codec
	MaxMsgSize int
}

Options contains codec options

func NewOptions

func NewOptions(opts ...Option) Options

NewOptions returns new options