/
packet.go
58 lines (48 loc) · 1.55 KB
/
packet.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package packet
import (
"github.com/walleframe/walle/process/message"
"github.com/walleframe/walle/process/metadata"
)
//go:generate mockgen -source packet.go -destination ../../testpkg/mock_packet/packet.go
// PacketCmd first byte,
type PacketCmd byte
const (
// CmdNotify notify,push,oneway
CmdNotify PacketCmd = iota
CmdRequest
CmdResponse
)
// PacketFlag second byte,internal message flag.
type PacketFlag byte
const (
// FlagError message is an error response
FlagError PacketFlag = 0x01
)
// Encoder use for encode and decode source packet
type Encoder interface {
Encode(buf []byte) []byte
Decode(buf []byte) []byte
}
// Pool reuse packet pool
type Pool interface {
Get() interface{}
Put(interface{})
}
// Codec Use for marshal/unmarshal packet.Packet from bytes
type Codec interface {
Marshal(p interface{}) ([]byte, error)
Unmarshal(data []byte, p interface{}) error
}
// ProtocolWraper wrap all packet operate, use for custom packet struct.
type ProtocolWraper interface {
// unmarshal packet's payload by msg codec
PayloadUnmarshal(pkg interface{}, codec message.Codec, obj interface{}) error
// marshal packet's payload by msg codec,then set payload binary data into message buf.
PayloadMarshal(pkg interface{}, codec message.Codec, payload interface{}) (err error)
// new response packet
NewResponse(inPkg, outPkg interface{}, md metadata.MD) (err error)
// new request packet
NewPacket(inPkg interface{}, cmd PacketCmd, uri interface{}, md metadata.MD) (err error)
// get pkg metadata
GetMetadata(pkg interface{}) (md metadata.MD, err error)
}