packet

Documentation

Index

• Variables
• type IPacket
  • func NewWSPacket(typ int, data []byte) IPacket
• type Packer
• type PackerBuilder
• type WSPacket
  • func (p *WSPacket) GetBody() []byte
  • func (p *WSPacket) GetHeader() any
  • func (p *WSPacket) GetLen() uint64
  • func (p *WSPacket) String() string

Variables

var (
	// ErrWrongPacketType represents a wrong packet type.
	ErrWrongPacketType = errors.New("wrong packet type")
	// ErrPacketSizeExceed represents a wrong packet size.
	ErrPacketSizeExceed = errors.New("packet size exceed")
)

Types

type IPacket

type IPacket interface {
	GetHeader() any  // 数据帧头部 Header
	GetLen() uint64  // 数据帧长度 8bytes，根据实际情况进行转换
	GetBody() []byte // 数据 Body
}

IPacket 数据帧

func NewWSPacket

func NewWSPacket(typ int, data []byte) IPacket

type Packer

type Packer interface {
	// Pack 封包，将原始数据构造为二进制流数据帧
	Pack(header any, data []byte) ([]byte, error)

	// Unpack 解包
	Unpack(data []byte) ([]IPacket, error)
}

Packer 数据帧 封包/解包

type PackerBuilder

type PackerBuilder func() Packer

PackerBuilder Packer构建器

type WSPacket

type WSPacket struct {
	MessageType int
	Len         uint64
	Raw         []byte
}

func (*WSPacket) GetBody

func (p *WSPacket) GetBody() []byte

func (*WSPacket) GetHeader

func (p *WSPacket) GetHeader() any

func (*WSPacket) GetLen

func (p *WSPacket) GetLen() uint64

func (*WSPacket) String

func (p *WSPacket) String() string