ws

Documentation

Index

• type Client
  • func Connect(addr string, msgBufferSize int) (*Client, error)
  • func NewClient(addr string, msgBufferSize int, autoExit bool) (*Client, error)
  • func (receiver *Client) Close()
  • func (receiver *Client) Connect() error
  • func (receiver *Client) IsClose() bool
  • func (receiver *Client) Receiver(val any) error
  • func (receiver *Client) ReceiverMessage() (string, error)
  • func (receiver *Client) Send(msg any) error
  • func (receiver *Client) SetHeader(key, value string)
  • func (receiver *Client) SetHeaderMap(m map[string]any)

Types

type Client

type Client struct {
	Ctx ctx.Context // 用于通知应用端是否断开连接

	AutoExit bool // 当断开连接时，自动退出（抛出异常）
	// contains filtered or unexported fields
}

Client websocket 客户端

func Connect

func Connect(addr string, msgBufferSize int) (*Client, error)

Connect 连接

func NewClient

func NewClient(addr string, msgBufferSize int, autoExit bool) (*Client, error)

NewClient 实例化对象

func (*Client) Close

func (receiver *Client) Close()

Close 关闭连接

func (*Client) Connect

func (receiver *Client) Connect() error

Connect 连接

func (*Client) IsClose

func (receiver *Client) IsClose() bool

IsClose 是否已断开连接

func (*Client) Receiver

func (receiver *Client) Receiver(val any) error

Receiver 接收消息（并反序列化成val）

func (*Client) ReceiverMessage

func (receiver *Client) ReceiverMessage() (string, error)

ReceiverMessage 接收消息

func (*Client) Send

func (receiver *Client) Send(msg any) error

Send 发送消息，如果msg不是go的基础类型，则会自动序列化成json

func (*Client) SetHeader

func (receiver *Client) SetHeader(key, value string)

SetHeader 设置header

func (*Client) SetHeaderMap

func (receiver *Client) SetHeaderMap(m map[string]any)

SetHeaderMap 设置header