codec

Documentation

Index

• Constants
• Variables
• func MarshalV1(w io.Writer, pkt fatchoy.IPacket, encryptor cipher.BlockCryptor) (int, error)
• func ReadLenData(r io.Reader) ([]byte, error)
• func ReadPacket(r io.Reader, decrypt cipher.BlockCryptor, pkt fatchoy.IPacket) error
• func UnmarshalV1(header Header, body []byte, decrypt cipher.BlockCryptor, pkt fatchoy.IPacket) error
• func WriteLenData(w io.Writer, data []byte) (int, error)
• func WritePacket(w io.Writer, encrypt cipher.BlockCryptor, pkt fatchoy.IPacket) error
• type Header
  • func NewHeader() Header
  • func ReadV1(r io.Reader) (Header, []byte, error)
  • func (h Header) CalcChecksum(payload []byte) uint32
  • func (h Header) Checksum() uint32
  • func (h Header) Command() int32
  • func (h Header) Flag() uint8
  • func (h Header) Len() uint32
  • func (h Header) MD5Sum() string
  • func (h Header) Pack(pkt fatchoy.IPacket, size uint32)
  • func (h Header) Seq() int16
  • func (h Header) SetChecksum(crc uint32)
  • func (h Header) Type() uint8
• type Version

Constants

const (
	HeaderSize       = 16               // 包头大小(包含长度）
	PacketBytesLimit = (1 << 24) - 1    // 3字节限制
	MaxPayloadBytes  = 16 * 1024 * 1024 // 16M
)

Variables

var CompressThreshold = 4096 // 默认压缩阈值，4K

Functions

func MarshalV1

func MarshalV1(w io.Writer, pkt fatchoy.IPacket, encryptor cipher.BlockCryptor) (int, error)

内部不应该修改pkt的body

func ReadLenData

func ReadLenData(r io.Reader) ([]byte, error)

read length-prefixed data

func ReadPacket

func ReadPacket(r io.Reader, decrypt cipher.BlockCryptor, pkt fatchoy.IPacket) error

读取一个packet

func UnmarshalV1

func UnmarshalV1(header Header, body []byte, decrypt cipher.BlockCryptor, pkt fatchoy.IPacket) error

func WriteLenData

func WriteLenData(w io.Writer, data []byte) (int, error)

write length-prefixed data

func WritePacket

func WritePacket(w io.Writer, encrypt cipher.BlockCryptor, pkt fatchoy.IPacket) error

写入一个packet

Types

type Header

type Header []byte

不包含length

func NewHeader

func NewHeader() Header

func ReadV1

func ReadV1(r io.Reader) (Header, []byte, error)

使用从r读取消息到pkt，并按需使用decrypt解密，返回读取长度和错误

func (Header) CalcChecksum

func (h Header) CalcChecksum(payload []byte) uint32

校验码包含head和body

func (Header) Checksum

func (h Header) Checksum() uint32

CRC校验码

func (Header) Command

func (h Header) Command() int32

func (Header) Flag

func (h Header) Flag() uint8

标记位

func (Header) Len

func (h Header) Len() uint32

func (Header) MD5Sum

func (h Header) MD5Sum() string

func (Header) Pack

func (h Header) Pack(pkt fatchoy.IPacket, size uint32)

func (Header) Seq

func (h Header) Seq() int16

session内的唯一序号

func (Header) SetChecksum

func (h Header) SetChecksum(crc uint32)

func (Header) Type

func (h Header) Type() uint8

标记位

type Version

type Version uint8

const (
	VersionV1 Version = 1
)