procs

Documentation

Index

• func JsonMarshal(messageID MessageID, input any) (output *msgs.JsonMsg, err error)
• func ProtoMarshal(messageID MessageID, input proto.Message) (output *msgs.ProtoMsg, err error)
• type Json
  • func NewJson() *Json
  • func (this *Json) Base64(enable bool) *Json
  • func (this *Json) Decode(input []byte) (output any, err error)
  • func (this *Json) DesCBC(enable bool, key, iv string) *Json
  • func (this *Json) Encode(input any) (output []byte, err error)
  • func (this *Json) Process(input any) error
• type MessageID
  • func JsonUnmarshal[T any](input any) (messageID MessageID, output *T, err error)
  • func ProtoUnmarshal[T any](input any) (messageID MessageID, output *T, err error)
• type Process
• type Processor
• type Procmgr
  • func NewProcmgr() *Procmgr
  • func (this *Procmgr) Add(messageID MessageID, process Process)
  • func (this *Procmgr) Del(messageID MessageID)
  • func (this *Procmgr) Get(messageID MessageID) Process
• type Proto
  • func NewProto() *Proto
  • func (this *Proto) Base64(enable bool) *Proto
  • func (this *Proto) Decode(input []byte) (output any, err error)
  • func (this *Proto) DesCBC(enable bool, key, iv string) *Proto
  • func (this *Proto) Encode(input any) (output []byte, err error)
  • func (this *Proto) Process(input any) error

Functions

func JsonMarshal

func JsonMarshal(messageID MessageID, input any) (output *msgs.JsonMsg, err error)

JsonMarshal json訊息序列化

func ProtoMarshal

func ProtoMarshal(messageID MessageID, input proto.Message) (output *msgs.ProtoMsg, err error)

ProtoMarshal 序列化proto訊息

Types

type Json

type Json struct {
	*Procmgr // 管理器
	// contains filtered or unexported fields
}

Json json處理器, 封包結構使用JsonMsg, 可以選擇是否啟用base64編碼或是des-cbc加密

• 訊息定義: support/proto/mizugo/msg-go/msgs-json/jsonmsg.go
• 訊息定義: support/proto/mizugo/msg-cs/msgs-json/Jsonmsg.cs
• 封包編碼: json編碼成位元陣列, (可選)des-cbc加密, (可選)base64編碼
• 封包解碼: (可選)base64解碼, (可選)des-cbc解密, json解碼成訊息結構

func NewJson

func NewJson() *Json

NewJson 建立json處理器

func (*Json) Base64

func (this *Json) Base64(enable bool) *Json

Base64 設定是否啟用base64

func (*Json) Decode

func (this *Json) Decode(input []byte) (output any, err error)

Decode 封包解碼

func (*Json) DesCBC

func (this *Json) DesCBC(enable bool, key, iv string) *Json

DesCBC 是否啟用des-cbc加密

func (*Json) Encode

func (this *Json) Encode(input any) (output []byte, err error)

Encode 封包編碼

func (*Json) Process

func (this *Json) Process(input any) error

Process 訊息處理

type MessageID

type MessageID = int32

MessageID 訊息編號, 設置為int32以跟proto的列舉類型統一

func JsonUnmarshal

func JsonUnmarshal[T any](input any) (messageID MessageID, output *T, err error)

JsonUnmarshal json訊息反序列化

func ProtoUnmarshal

func ProtoUnmarshal[T any](input any) (messageID MessageID, output *T, err error)

ProtoUnmarshal 反序列化proto訊息

type Process

type Process func(message any)

Process 訊息處理函式類型

type Processor

type Processor interface {
	// Encode 封包編碼
	Encode(input any) (output []byte, err error)

	// Decode 封包解碼
	Decode(input []byte) (output any, err error)

	// Process 訊息處理
	Process(input any) error

	// Add 新增訊息處理
	Add(messageID MessageID, process Process)

	// Del 刪除訊息處理
	Del(messageID MessageID)
}

Processor 處理介面, 負責以下功能

• 封包編碼: 在 Encode 中實現
• 封包解碼: 在 Decode 中實現
• 收到訊息時的處理: 在 Process 中實現
• 管理訊息處理函式: 在 Add, Del 中實現

如果想要建立新的處理結構, 需要遵循以下流程

• 定義訊息結構, 訊息結構必須包含 MessageID
• 訊息結構如果要使用protobuf, 可以把定義檔放在support/proto/mizugo中
• 定義處理結構, 處理結構需要繼承 Processor 介面, 並實現所有函式; 在處理結構中包含 Procmgr 結構來實現訊息處理功能, 這樣只要實作 Encode, Decode, Process 三個函式就可以了

mizugo提供的預設處理器有 Json, Proto

type Procmgr

type Procmgr struct {
	// contains filtered or unexported fields
}

Procmgr 管理器, 負責管理訊息處理函式

func NewProcmgr

func NewProcmgr() *Procmgr

NewProcmgr 建立管理器

func (*Procmgr) Add

func (this *Procmgr) Add(messageID MessageID, process Process)

Add 新增處理函式

func (*Procmgr) Del

func (this *Procmgr) Del(messageID MessageID)

Del 刪除處理函式

func (*Procmgr) Get

func (this *Procmgr) Get(messageID MessageID) Process

Get 取得處理函式

type Proto

type Proto struct {
	*Procmgr // 管理器
	// contains filtered or unexported fields
}

Proto proto處理器, 封包結構使用ProtoMsg, 可以選擇是否啟用base64編碼或是des-cbc加密

• 訊息定義: support/proto/mizugo/protomsg.proto
• 封包編碼: protobuf編碼成位元陣列, (可選)des-cbc加密, (可選)base64編碼
• 封包解碼: (可選)base64解碼, (可選)des-cbc解密, protobuf解碼成訊息結構

func NewProto

func NewProto() *Proto

NewProto 建立proto處理器

func (*Proto) Base64

func (this *Proto) Base64(enable bool) *Proto

Base64 設定是否啟用base64

func (*Proto) Decode

func (this *Proto) Decode(input []byte) (output any, err error)

Decode 封包解碼

func (*Proto) DesCBC

func (this *Proto) DesCBC(enable bool, key, iv string) *Proto

DesCBC 是否啟用des-cbc加密

func (*Proto) Encode

func (this *Proto) Encode(input any) (output []byte, err error)

Encode 封包編碼

func (*Proto) Process

func (this *Proto) Process(input any) error

Process 訊息處理