client

Documentation

Index

• type Client
  • func CloneClient(client *Client) *Client
  • func NewClient(core Core) *Client
  • func NewTCP(addr string) *Client
  • func NewUnixDomainSocket(addr string) *Client
  • func NewWebsocket(addr string) *Client
  • func (slf *Client) Close(err ...error)
  • func (slf *Client) GetServerAddr() string
  • func (slf *Client) IsConnected() bool
  • func (slf Client) OnConnectionClosedEvent(conn *Client, err any)
  • func (slf Client) OnConnectionOpenedEvent(conn *Client)
  • func (slf Client) OnConnectionReceivePacketEvent(conn *Client, wst int, packet []byte)
  • func (slf Client) RegConnectionClosedEvent(handle ConnectionClosedEventHandle)
  • func (slf Client) RegConnectionOpenedEvent(handle ConnectionOpenedEventHandle)
  • func (slf Client) RegConnectionReceivePacketEvent(handle ConnectionReceivePacketEventHandle)
  • func (slf *Client) Run(block ...bool) error
  • func (slf *Client) Write(packet []byte, callback ...func(err error))
  • func (slf *Client) WriteWS(wst int, packet []byte, callback ...func(err error))
• type ConnectionClosedEventHandle
• type ConnectionOpenedEventHandle
• type ConnectionReceivePacketEventHandle
• type Core
• type Packet
• type TCP
  • func (slf *TCP) Clone() Core
  • func (slf *TCP) Close()
  • func (slf *TCP) GetServerAddr() string
  • func (slf *TCP) Run(runState chan<- error, receive func(wst int, packet []byte))
  • func (slf *TCP) Write(packet *Packet) error
• type UnixDomainSocket
  • func (slf *UnixDomainSocket) Clone() Core
  • func (slf *UnixDomainSocket) Close()
  • func (slf *UnixDomainSocket) GetServerAddr() string
  • func (slf *UnixDomainSocket) Run(runState chan<- error, receive func(wst int, packet []byte))
  • func (slf *UnixDomainSocket) Write(packet *Packet) error
• type Websocket
  • func (slf *Websocket) Clone() Core
  • func (slf *Websocket) Close()
  • func (slf *Websocket) GetServerAddr() string
  • func (slf *Websocket) Run(runState chan<- error, receive func(wst int, packet []byte))
  • func (slf *Websocket) Write(packet *Packet) error

Types

type Client

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

Client 客户端

func CloneClient

func CloneClient(client *Client) *Client

CloneClient 克隆客户端

func NewClient

func NewClient(core Core) *Client

NewClient 创建客户端

func NewTCP

func NewTCP(addr string) *Client

func NewUnixDomainSocket

func NewUnixDomainSocket(addr string) *Client

func NewWebsocket

func NewWebsocket(addr string) *Client

NewWebsocket 创建 websocket 客户端

func (*Client) Close

func (slf *Client) Close(err ...error)

Close 关闭

func (*Client) GetServerAddr

func (slf *Client) GetServerAddr() string

GetServerAddr 获取服务器地址

func (*Client) IsConnected

func (slf *Client) IsConnected() bool

IsConnected 是否已连接

func (Client) OnConnectionClosedEvent

func (slf Client) OnConnectionClosedEvent(conn *Client, err any)

func (Client) OnConnectionOpenedEvent

func (slf Client) OnConnectionOpenedEvent(conn *Client)

func (Client) OnConnectionReceivePacketEvent

func (slf Client) OnConnectionReceivePacketEvent(conn *Client, wst int, packet []byte)

func (Client) RegConnectionClosedEvent

func (slf Client) RegConnectionClosedEvent(handle ConnectionClosedEventHandle)

RegConnectionClosedEvent 注册连接关闭事件

func (Client) RegConnectionOpenedEvent

func (slf Client) RegConnectionOpenedEvent(handle ConnectionOpenedEventHandle)

RegConnectionOpenedEvent 注册连接打开事件

func (Client) RegConnectionReceivePacketEvent

func (slf Client) RegConnectionReceivePacketEvent(handle ConnectionReceivePacketEventHandle)

RegConnectionReceivePacketEvent 注册连接接收数据包事件

func (*Client) Run

func (slf *Client) Run(block ...bool) error

Run 运行客户端，当客户端已运行时，会先关闭客户端再重新运行

• block 以阻塞方式运行

func (*Client) Write

func (slf *Client) Write(packet []byte, callback ...func(err error))

Write 向连接中写入数据

func (*Client) WriteWS

func (slf *Client) WriteWS(wst int, packet []byte, callback ...func(err error))

WriteWS 向连接中写入指定 websocket 数据类型

• wst: websocket模式中指定消息类型

type ConnectionClosedEventHandle

type ConnectionClosedEventHandle func(conn *Client, err any)

type ConnectionOpenedEventHandle

type ConnectionOpenedEventHandle func(conn *Client)

type ConnectionReceivePacketEventHandle

type ConnectionReceivePacketEventHandle func(conn *Client, wst int, packet []byte)

type Core

type Core interface {
	// Run 启动客户端
	//  - runState: 运行状态，当客户端启动完成时，应该向该通道发送 error 或 nil
	//  - receive: 接收到数据包时应该将数据包发送到该函数，wst 表示 websocket 的数据类型，data 表示数据包
	Run(runState chan<- error, receive func(wst int, packet []byte))

	// Write 向客户端写入数据包
	Write(packet *Packet) error

	// Close 关闭客户端
	Close()

	// GetServerAddr 获取服务器地址
	GetServerAddr() string

	// Clone 克隆客户端
	Clone() Core
}

type Packet

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

type TCP

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

func (*TCP) Clone

func (slf *TCP) Clone() Core

func (*TCP) Close

func (slf *TCP) Close()

func (*TCP) GetServerAddr

func (slf *TCP) GetServerAddr() string

func (*TCP) Run

func (slf *TCP) Run(runState chan<- error, receive func(wst int, packet []byte))

func (*TCP) Write

func (slf *TCP) Write(packet *Packet) error

type UnixDomainSocket

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

func (*UnixDomainSocket) Clone

func (slf *UnixDomainSocket) Clone() Core

func (*UnixDomainSocket) Close

func (slf *UnixDomainSocket) Close()

func (*UnixDomainSocket) GetServerAddr

func (slf *UnixDomainSocket) GetServerAddr() string

func (*UnixDomainSocket) Run

func (slf *UnixDomainSocket) Run(runState chan<- error, receive func(wst int, packet []byte))

func (*UnixDomainSocket) Write

func (slf *UnixDomainSocket) Write(packet *Packet) error

type Websocket

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

Websocket websocket 客户端

func (*Websocket) Clone

func (slf *Websocket) Clone() Core

func (*Websocket) Close

func (slf *Websocket) Close()

func (*Websocket) GetServerAddr

func (slf *Websocket) GetServerAddr() string

func (*Websocket) Run

func (slf *Websocket) Run(runState chan<- error, receive func(wst int, packet []byte))

func (*Websocket) Write

func (slf *Websocket) Write(packet *Packet) error