README
¶
Protocol
一个简易的数据传输协议，保证在流传输协议下，每次Write的数据对方能完整(不多&不少)的接收和处理
import "git.ksyaki.co/gomod/protocol"
样例请参照protocol_test.go中的示例，示例中包含了对tcp的封装
Documentation
¶
Index ¶
- Variables
- type HeartbeatTimeoutCallback
- type KillCallback
- type Protocol
- func (p *Protocol) Connect(activeHeartbeatSignalSender bool)
- func (p *Protocol) HeartbeatLastReceived() int64
- func (p *Protocol) HeartbeatLastSend() int64
- func (p *Protocol) Kill()
- func (p *Protocol) Tag() string
- func (p *Protocol) Wait()
- func (p *Protocol) Write(flag, encryptor uint8, data []byte) error
- type ReadCallback
- type ReadPrepare
- type WritePrepare
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type KillCallback ¶
type KillCallback func()
type Protocol ¶
type Protocol struct {
// contains filtered or unexported fields
}
func New ¶
func New(tag string, r io.Reader, w io.Writer, passwordAes, passwordXor string, heartbeatInterval, heartbeatTimeout uint32, sendQueueSize, receiveQueueSize int, readCallback ReadCallback, heartbeatTimeoutCallback HeartbeatTimeoutCallback, killCallback KillCallback, readPrepare ReadPrepare, writePrepare WritePrepare) (prot *Protocol, err error)
New 返回一个protocol实例
tag: 标签，用于区分protocol实例 r: 数据流的reader w: 数据流的writer writeQueueSize: 发送等待队列长度 readCallback: 用于处理获取到的数据，每个package中的数据都会完整的保存在data中 heartbeatTimeoutCallback: 心跳请求超时后的处理函数 setFuncBeforeRead: 在reader读取数据前，设置reader的读取截止时间 setFuncBeforeWrite: 在writer发送数据前，设置writer的发送截止时间 killCallback: status被标记为statusKilled时执行，可以用于关闭reader和writer
type ReadPrepare ¶
type ReadPrepare func()
type WritePrepare ¶
type WritePrepare func()
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.