connection

Documentation

Index

• Variables
• type CallBack
• type Connection
  • func New(fd int, loop *eventloop.EventLoop, sa unix.Sockaddr, protocol Protocol, ...) *Connection
  • func (c *Connection) Close() error
  • func (c *Connection) Connected() bool
  • func (c *Connection) Context() interface{}
  • func (c *Connection) HandleEvent(fd int, events poller.Event)
  • func (c *Connection) PeerAddr() string
  • func (c *Connection) ReadBufferLength() int64
  • func (c *Connection) Send(data interface{}, opts ...Option) error
  • func (c *Connection) SetContext(ctx interface{})
  • func (c *Connection) ShutdownWrite() error
  • func (c *Connection) UserBuffer() *[]byte
  • func (c *Connection) WriteBufferLength() int64
• type DefaultProtocol
  • func (d *DefaultProtocol) Packet(c *Connection, data interface{}) []byte
  • func (d *DefaultProtocol) UnPacket(c *Connection, buffer *ringbuffer.RingBuffer) (interface{}, []byte)
• type KeyValueContext
  • func (c *KeyValueContext) Delete(key string)
  • func (c *KeyValueContext) Get(key string) (value interface{}, exists bool)
  • func (c *KeyValueContext) Set(key string, value interface{})
• type Option
  • func SendInLoop(f SendInLoopFunc) Option
• type Options
• type Protocol
• type SendInLoopFunc

Variables

var ErrConnectionClosed = errors.New("connection closed")

Types

type CallBack

type CallBack interface {
	OnMessage(c *Connection, ctx interface{}, data []byte) interface{}
	OnClose(c *Connection)
}

type Connection

type Connection struct {
	KeyValueContext
	// contains filtered or unexported fields
}

Connection TCP 连接

func New

func New(fd int,
	loop *eventloop.EventLoop,
	sa unix.Sockaddr,
	protocol Protocol,
	tw *timingwheel.TimingWheel,
	idleTime time.Duration,
	callBack CallBack) *Connection

New 创建 Connection

func (*Connection) Close

func (c *Connection) Close() error

Close 关闭连接

func (*Connection) Connected

func (c *Connection) Connected() bool

Connected 是否已连接

func (*Connection) Context

func (c *Connection) Context() interface{}

Context 获取 Context

func (*Connection) HandleEvent

func (c *Connection) HandleEvent(fd int, events poller.Event)

HandleEvent 内部使用，event loop 回调

func (*Connection) PeerAddr

func (c *Connection) PeerAddr() string

PeerAddr 获取客户端地址信息

func (*Connection) ReadBufferLength

func (c *Connection) ReadBufferLength() int64

ReadBufferLength read buffer 当前积压的数据长度

func (*Connection) Send

func (c *Connection) Send(data interface{}, opts ...Option) error

Send 用来在非 loop 协程发送

func (*Connection) SetContext

func (c *Connection) SetContext(ctx interface{})

SetContext 设置 Context

func (*Connection) ShutdownWrite

func (c *Connection) ShutdownWrite() error

ShutdownWrite 关闭可写端，等待读取完接收缓冲区所有数据

func (*Connection) UserBuffer

func (c *Connection) UserBuffer() *[]byte

func (*Connection) WriteBufferLength

func (c *Connection) WriteBufferLength() int64

WriteBufferLength write buffer 当前积压的数据长度

type DefaultProtocol

type DefaultProtocol struct{}

DefaultProtocol 默认 Protocol

func (*DefaultProtocol) Packet

func (d *DefaultProtocol) Packet(c *Connection, data interface{}) []byte

Packet 封包

func (*DefaultProtocol) UnPacket

func (d *DefaultProtocol) UnPacket(c *Connection, buffer *ringbuffer.RingBuffer) (interface{}, []byte)

UnPacket 拆包

type KeyValueContext

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

func (*KeyValueContext) Delete

func (c *KeyValueContext) Delete(key string)

func (*KeyValueContext) Get

func (c *KeyValueContext) Get(key string) (value interface{}, exists bool)

func (*KeyValueContext) Set

func (c *KeyValueContext) Set(key string, value interface{})

type Option

type Option func(*Options)

func SendInLoop

func SendInLoop(f SendInLoopFunc) Option

type Options

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

type Protocol

type Protocol interface {
	UnPacket(c *Connection, buffer *ringbuffer.RingBuffer) (interface{}, []byte)
	Packet(c *Connection, data interface{}) []byte
}

Protocol 自定义协议编解码接口

type SendInLoopFunc

type SendInLoopFunc func(interface{})