protocol

Documentation

Index

• Constants
• func RegisterCodec(codec Codec)
• type Codec
  • func GetCodec(codecType string) Codec
• type CodecJson
  • func (c CodecJson) Marshal(v *Message) ([]byte, error)
  • func (c CodecJson) Name() string
  • func (c CodecJson) Unmarshal(data []byte, v *Message) error
• type CodecSimple
  • func (c CodecSimple) Marshal(msg *Message) ([]byte, error)
  • func (c CodecSimple) Name() string
  • func (c CodecSimple) Unmarshal(data []byte, msg *Message) error
• type Message
• type Meta
• type MsgItem
• type Protocol

Constants

const CodecJsonName = "json"

const CodecSimpleName = "simple"

Functions

func RegisterCodec

func RegisterCodec(codec Codec)

Types

type Codec

type Codec interface {
	// Marshal returns the wire format of v.
	Marshal(v *Message) ([]byte, error)
	// Unmarshal parses the wire format into v.
	Unmarshal(data []byte, v *Message) error
	// 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
}

func GetCodec

func GetCodec(codecType string) Codec

The content-subtype is expected to be lowercase.

type CodecJson

type CodecJson struct{}

func (CodecJson) Marshal

func (c CodecJson) Marshal(v *Message) ([]byte, error)

func (CodecJson) Name

func (c CodecJson) Name() string

func (CodecJson) Unmarshal

func (c CodecJson) Unmarshal(data []byte, v *Message) error

type CodecSimple

type CodecSimple struct{}

func (CodecSimple) Marshal

func (c CodecSimple) Marshal(msg *Message) ([]byte, error)

func (CodecSimple) Name

func (c CodecSimple) Name() string

func (CodecSimple) Unmarshal

func (c CodecSimple) Unmarshal(data []byte, msg *Message) error

type Message

type Message struct {
	Meta     Meta     `json:"meta"`
	Method   string   `json:"method"`
	Request  *MsgItem `json:"request"`
	Response *MsgItem `json:"response"`
}

Message represents data across plugins

type Meta

type Meta struct {
	Version int    `json:"version"`
	UUID    string `json:"uuid"`
	// Nanosecond
	Timestamp       int64 `json:"timestamp"`
	ContainResponse bool  `json:"containResponse"`
}

type MsgItem

type MsgItem struct {
	Headers map[string]string `json:"headers"`
	Body    string            `json:"body"`
}

type Protocol

type Protocol interface {
	Encode(msg *Message) (bt []byte, err error)
	Decode(bt []byte) (msg *Message, err error)
}