Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

codec

package

Go to main page

Versions in this module

v0

v0.1.25

Jan 22, 2024

v0.1.24

Jan 22, 2024

v0.1.23

Jan 22, 2024

v0.1.22

Jan 22, 2024

v0.1.21

Jan 19, 2024

v0.1.20

Jan 13, 2024

v0.1.19

Jan 13, 2024

Changes in this version

+ var ErrDataNotEnough = io.ErrShortBuffer

+ var ErrIncorrectMAC = errors.New("gtp: incorrect MAC")

+ type CompressionModule struct

+ CompressionStream method.CompressionStream

+ func (m *CompressionModule) Compress(src []byte) (dst binaryutil.RecycleBytes, compressed bool, err error)

+ func (m *CompressionModule) Uncompress(src []byte) (dst binaryutil.RecycleBytes, err error)

+ type Decoder struct

+ CompressionModule ICompressionModule

+ EncryptionModule IEncryptionModule

+ MACModule IMACModule

+ MsgCreator gtp.IMsgCreator

+ func (d *Decoder) Decode(validate ...IValidate) (gtp.MsgPacket, error)

+ func (d *Decoder) DecodeBuff(buff *bytes.Buffer, validate ...IValidate) (gtp.MsgPacket, error)

+ func (d *Decoder) DecodeBytes(data []byte, validate ...IValidate) (gtp.MsgPacket, error)

+ func (d *Decoder) GC()

+ func (d *Decoder) ReadFrom(r io.Reader) (int64, error)

+ func (d *Decoder) Reset()

+ func (d *Decoder) Write(p []byte) (int, error)

+ type DecoderCreator struct

+ func CreateDecoder(msgCreator gtp.IMsgCreator) DecoderCreator

+ func (dc DecoderCreator) SetupCompressionModule(compressionModule ICompressionModule) DecoderCreator

+ func (dc DecoderCreator) SetupEncryptionModule(encryptionModule IEncryptionModule) DecoderCreator

+ func (dc DecoderCreator) SetupMACModule(macModule IMACModule) DecoderCreator

+ func (dc DecoderCreator) Spawn() IDecoder

+ type Encoder struct

+ CompressedSize int

+ CompressionModule ICompressionModule

+ Encryption bool

+ EncryptionModule IEncryptionModule

+ MACModule IMACModule

+ PatchMAC bool

+ func (e *Encoder) Encode(flags gtp.Flags, msg gtp.MsgReader) error

+ func (e *Encoder) EncodeBuff(buff *bytes.Buffer, flags gtp.Flags, msg gtp.MsgReader) error

+ func (e *Encoder) EncodeBytes(flags gtp.Flags, msg gtp.MsgReader) (binaryutil.RecycleBytes, error)

+ func (e *Encoder) EncodeWriter(writer io.Writer, flags gtp.Flags, msg gtp.MsgReader) error

+ func (e *Encoder) Read(p []byte) (int, error)

+ func (e *Encoder) Reset()

+ func (e *Encoder) WriteTo(w io.Writer) (int64, error)

+ type EncoderCreator struct

+ func CreateEncoder() EncoderCreator

+ func (ec EncoderCreator) SetupCompressionModule(compressionModule ICompressionModule, compressedSize int) EncoderCreator

+ func (ec EncoderCreator) SetupEncryptionModule(encryptionModule IEncryptionModule) EncoderCreator

+ func (ec EncoderCreator) SetupMACModule(macModule IMACModule) EncoderCreator

+ func (ec EncoderCreator) Spawn() IEncoder

+ type EncryptionModule struct

+ Cipher method.Cipher

+ FetchNonce FetchNonce

+ Padding method.Padding

+ func (m *EncryptionModule) SizeOfAddition(msgLen int) (int, error)

+ func (m *EncryptionModule) Transforming(dst, src []byte) (ret binaryutil.RecycleBytes, err error)

+ type FetchNonce = generic.PairFunc0[[]byte, error]

+ type ICompressionModule interface

+ Compress func(src []byte) (dst binaryutil.RecycleBytes, compressed bool, err error)

+ Uncompress func(src []byte) (dst binaryutil.RecycleBytes, err error)

+ func NewCompressionModule(cs method.CompressionStream) ICompressionModule

+ type IDecoder interface

+ Decode func(validate ...IValidate) (gtp.MsgPacket, error)

+ DecodeBuff func(buff *bytes.Buffer, validate ...IValidate) (gtp.MsgPacket, error)

+ DecodeBytes func(data []byte, validate ...IValidate) (gtp.MsgPacket, error)

+ GC func()

+ Reset func()

+ type IEncoder interface

+ Encode func(flags gtp.Flags, msg gtp.MsgReader) error

+ EncodeBuff func(buff *bytes.Buffer, flags gtp.Flags, msg gtp.MsgReader) error

+ EncodeBytes func(flags gtp.Flags, msg gtp.MsgReader) (binaryutil.RecycleBytes, error)

+ EncodeWriter func(writer io.Writer, flags gtp.Flags, msg gtp.MsgReader) error

+ Reset func()

+ type IEncryptionModule interface

+ SizeOfAddition func(msgLen int) (int, error)

+ Transforming func(dst, src []byte) (binaryutil.RecycleBytes, error)

+ func NewEncryptionModule(cipher method.Cipher, padding method.Padding, fetchNonce FetchNonce) IEncryptionModule

+ type IMACModule interface

+ PatchMAC func(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst binaryutil.RecycleBytes, err error)

+ SizeofMAC func(msgLen int) int

+ VerifyMAC func(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst []byte, err error)

+ func NewMAC32Module(h hash.Hash32, pk []byte) IMACModule

+ func NewMAC64Module(h hash.Hash64, pk []byte) IMACModule

+ func NewMACModule(h hash.Hash, pk []byte) IMACModule

+ type IValidate interface

+ Validate func(msgHead gtp.MsgHead, msgBuff []byte) error

+ type MAC32Module struct

+ Hash hash.Hash32

+ PrivateKey []byte

+ func (m *MAC32Module) PatchMAC(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst binaryutil.RecycleBytes, err error)

+ func (m *MAC32Module) SizeofMAC(msgLen int) int

+ func (m *MAC32Module) VerifyMAC(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst []byte, err error)

+ type MAC64Module struct

+ Hash hash.Hash64

+ PrivateKey []byte

+ func (m *MAC64Module) PatchMAC(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst binaryutil.RecycleBytes, err error)

+ func (m *MAC64Module) SizeofMAC(msgLen int) int

+ func (m *MAC64Module) VerifyMAC(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst []byte, err error)

+ type MACModule struct

+ Hash hash.Hash

+ PrivateKey []byte

+ func (m *MACModule) PatchMAC(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst binaryutil.RecycleBytes, err error)

+ func (m *MACModule) SizeofMAC(msgLen int) int

+ func (m *MACModule) VerifyMAC(msgId gtp.MsgId, flags gtp.Flags, msgBuf []byte) (dst []byte, err error)