Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

protocol

package

Go to main page

Versions in this module

v1

v1.3.1

Feb 22, 2018

Changes in this version

+ var ErrMessageToLong = errors.New("message is too long")

+ func FreeMsg(msg *Message)

type Message

+ func GetPooledMsg() *Message

v1.0.5

Nov 20, 2024

v1.0.2

Mar 28, 2024

v1.0.1

Feb 28, 2024

v1.0.0

Feb 23, 2024

Changes in this version

+ const ServiceError

+ var Compressors = map[CompressType]Compressor

+ var ErrMessageTooLong = errors.New("message is too long")

+ var ErrMetaKVMissing = errors.New("wrong metadata lines. some keys or values are missing")

+ var ErrUnsupportedCompressor = errors.New("unsupported compressor")

+ var MaxMessageLength = 0

+ func MagicNumber() byte

+ func PutData(data *[]byte)

+ type CompressType byte

+ const Gzip

+ const None

+ type Compressor interface

+ Unzip func([]byte) ([]byte, error)

+ Zip func([]byte) ([]byte, error)

+ type GzipCompressor struct

+ func (c GzipCompressor) Unzip(data []byte) ([]byte, error)

+ func (c GzipCompressor) Zip(data []byte) ([]byte, error)

+ type Header [12]byte

+ func (h *Header) SetCompressType(ct CompressType)

+ func (h *Header) SetHeartbeat(hb bool)

+ func (h *Header) SetMessageStatusType(mt MessageStatusType)

+ func (h *Header) SetMessageType(mt MessageType)

+ func (h *Header) SetOneway(oneway bool)

+ func (h *Header) SetSeq(seq uint64)

+ func (h *Header) SetSerializeType(st SerializeType)

+ func (h *Header) SetVersion(v byte)

+ func (h Header) CheckMagicNumber() bool

+ func (h Header) CompressType() CompressType

+ func (h Header) IsHeartbeat() bool

+ func (h Header) IsOneway() bool

+ func (h Header) MessageStatusType() MessageStatusType

+ func (h Header) MessageType() MessageType

+ func (h Header) Seq() uint64

+ func (h Header) SerializeType() SerializeType

+ func (h Header) Version() byte

+ type Message struct

+ Metadata map[string]string

+ Payload []byte

+ ServiceMethod string

+ ServicePath string

+ func NewMessage() *Message

+ func Read(r io.Reader) (*Message, error)

+ func (m *Message) Decode(r io.Reader) error

+ func (m *Message) Reset()

+ func (m Message) Clone() *Message

+ func (m Message) Encode() []byte

+ func (m Message) EncodeSlicePointer() *[]byte

+ func (m Message) WriteTo(w io.Writer) (int64, error)

+ type MessageStatusType byte

+ const Error

+ const Normal

+ type MessageType byte

+ const Request

+ const Response

+ type RawDataCompressor struct

+ func (c RawDataCompressor) Unzip(data []byte) ([]byte, error)

+ func (c RawDataCompressor) Zip(data []byte) ([]byte, error)

+ type SerializeType byte

+ const JSON

+ const JSONIterCodec

+ const MsgPack

+ const ProtoBuffer

+ const SerializeNone

+ const Thrift

+ type SnappyCompressor struct

+ func (c *SnappyCompressor) Unzip(data []byte) ([]byte, error)

+ func (c *SnappyCompressor) Zip(data []byte) ([]byte, error)