tfilter

Documentation

Index

• Constants
• Variables
• func Reg(tFilter TransferFilter)
• func RegAES(key []byte)
• func RegGzip(level int)
• func RegMD5()
• type Gzip
  • func (that *Gzip) ID() byte
  • func (that *Gzip) Name() string
  • func (that *Gzip) OnPack(src []byte) ([]byte, error)
  • func (that *Gzip) OnUnpack(src []byte) (dest []byte, err error)
• type PipeTFilter
  • func NewPipeTFilter() *PipeTFilter
  • func (that *PipeTFilter) Append(filterID ...byte) error
  • func (that *PipeTFilter) AppendFrom(src *PipeTFilter)
  • func (that *PipeTFilter) IDs() []byte
  • func (that *PipeTFilter) Iterator(callback func(idx int, filter TransferFilter) bool)
  • func (that *PipeTFilter) Len() int
  • func (that *PipeTFilter) Names() []string
  • func (that *PipeTFilter) OnPack(data []byte) ([]byte, error)
  • func (that *PipeTFilter) OnUnpack(data []byte) ([]byte, error)
  • func (that *PipeTFilter) Reset()
• type TransferFilter
  • func Get(id byte) (TransferFilter, error)
  • func GetByName(name string) (TransferFilter, error)

Constants

const (
	AesId   = 'a'
	AesName = "aes"
)

const (
	GzipId   = 'z'
	GzipName = "gzip"
)

const (
	Md5Id   = '5'
	Md5Name = "md5"
)

Variables

var ErrTransferFilterTooLong = errors.New("The length of transfer pipe cannot be bigger than 255 ")

Functions

func Reg

func Reg(tFilter TransferFilter)

Reg 注册过滤器

func RegAES

func RegAES(key []byte)

func RegGzip

func RegGzip(level int)

RegGzip registers a gzip filter for transfer.

func RegMD5

func RegMD5()

RegMD5 注册md5校验过滤器

Types

type Gzip

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

func (*Gzip) ID

func (that *Gzip) ID() byte

ID returns transfer filter id.

func (*Gzip) Name

func (that *Gzip) Name() string

Name returns transfer filter name.

func (*Gzip) OnPack

func (that *Gzip) OnPack(src []byte) ([]byte, error)

OnPack performs filtering on packing.

func (*Gzip) OnUnpack

func (that *Gzip) OnUnpack(src []byte) (dest []byte, err error)

OnUnpack performs filtering on unpacking.

type PipeTFilter

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

PipeTFilter 传输过滤器切片，能批量执行注册的tFilter

func NewPipeTFilter

func NewPipeTFilter() *PipeTFilter

NewPipeTFilter 创建传输过滤器管道

func (*PipeTFilter) Append

func (that *PipeTFilter) Append(filterID ...byte) error

Append 追加传输过滤器

func (*PipeTFilter) AppendFrom

func (that *PipeTFilter) AppendFrom(src *PipeTFilter)

AppendFrom 从指定传输过滤器管道追加过滤器

func (*PipeTFilter) IDs

func (that *PipeTFilter) IDs() []byte

IDs 获取当前传输过滤器管道中的id

func (*PipeTFilter) Iterator

func (that *PipeTFilter) Iterator(callback func(idx int, filter TransferFilter) bool)

Iterator 迭代

func (*PipeTFilter) Len

func (that *PipeTFilter) Len() int

Len 当前传输过滤器管道的长度

func (*PipeTFilter) Names

func (that *PipeTFilter) Names() []string

Names 获取当前传输过滤器管道中的名字

func (*PipeTFilter) OnPack

func (that *PipeTFilter) OnPack(data []byte) ([]byte, error)

OnPack 打包，从最内层到最外层

func (*PipeTFilter) OnUnpack

func (that *PipeTFilter) OnUnpack(data []byte) ([]byte, error)

OnUnpack 解包，从最外层到最内层

func (*PipeTFilter) Reset

func (that *PipeTFilter) Reset()

Reset 清除传输过滤器管道

type TransferFilter

type TransferFilter interface {
	// ID 过滤器id
	ID() byte
	// Name 过滤器名字
	Name() string
	// OnPack 过滤器打包方法
	OnPack([]byte) ([]byte, error)
	// OnUnpack 过滤器解包方法
	OnUnpack([]byte) ([]byte, error)
}

TransferFilter 传输过滤器接口

func Get

func Get(id byte) (TransferFilter, error)

Get 通过id获取过滤器对象

func GetByName

func GetByName(name string) (TransferFilter, error)

GetByName 通过过滤器名称返回过滤器对象