The highest tagged major version is v2.

packet

package

v0.0.24 Latest Latest Go to latest Published: Jul 4, 2023 License: MIT Imports: 7 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dobyte/due

Links

Documentation ¶

Index ¶

Variables
func Pack(message *Message) ([]byte, error)
func SetPacker(packer Packer)
type Message
- func Unpack(data []byte) (*Message, error)
type Option
type Packer
- func GetPacker() Packer
- func NewPacker(opts ...Option) Packer

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrMessageIsNil    = errors.New("the message is nil")
	ErrSeqOverflow     = errors.New("the message seq overflow")
	ErrRouteOverflow   = errors.New("the message route overflow")
	ErrBufferOverflow  = errors.New("the message buffer overflow")
	ErrInvalidMessage  = errors.New("invalid message")
	ErrMessageTooLarge = errors.New("the message too large")
)

Functions ¶

func Pack ¶

func Pack(message *Message) ([]byte, error)

Pack 打包消息

func SetPacker ¶ added in v0.0.4

func SetPacker(packer Packer)

SetPacker 设置打包器

Types ¶

type Message ¶

type Message struct {
	Seq    int32  // 序列号
	Route  int32  // 路由ID
	Buffer []byte // 消息内容
}

func Unpack ¶

func Unpack(data []byte) (*Message, error)

Unpack 解包消息

type Option ¶ added in v0.0.4

type Option func(o *options)

func WithBufferBytesLen ¶ added in v0.0.21

func WithBufferBytesLen(bufferBytesLen int) Option

WithBufferBytesLen 设置消息字节长度

func WithByteOrder ¶ added in v0.0.4

func WithByteOrder(byteOrder binary.ByteOrder) Option

WithByteOrder 设置字节序

func WithRouteBytesLen ¶ added in v0.0.4

func WithRouteBytesLen(routeBytesLen int) Option

WithRouteBytesLen 设置路由字节长度

func WithSeqBytesLen ¶ added in v0.0.4

func WithSeqBytesLen(seqBytesLen int) Option

WithSeqBytesLen 设置序列号字节长度

type Packer ¶ added in v0.0.4

type Packer interface {
	// Pack 打包消息
	Pack(message *Message) ([]byte, error)
	// Unpack 解包消息
	Unpack(data []byte) (*Message, error)
}

func GetPacker ¶ added in v0.0.4

func GetPacker() Packer

GetPacker 获取打包器

func NewPacker ¶ added in v0.0.4

func NewPacker(opts ...Option) Packer

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL