websocket

Documentation

Overview

Package websocket is a tiny websocket client purpose-built for load-testing. It does not have any special features other than strictly what is needed.

Index

• type Client
  • func NewClient4(param *ClientParams) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) GetStatuses() error
  • func (c *Client) GetStatusesByIds(userIds []string) error
  • func (c *Client) SendBinaryMessage(action string, data map[string]interface{}) error
  • func (c *Client) SendMessage(action string, data map[string]interface{}) error
  • func (c *Client) UserTyping(channelId, parentId string) error
• type ClientParams

Types

type Client

type Client struct {
	EventChannel chan *model.WebSocketEvent
	// contains filtered or unexported fields
}

Client is the websocket client to perform all actions.

func NewClient4

func NewClient4(param *ClientParams) (*Client, error)

NewClient4 constructs a new WebSocket client.

func (*Client) Close

func (c *Client) Close()

Close closes the client.

func (*Client) GetStatuses

func (c *Client) GetStatuses() error

func (*Client) GetStatusesByIds

func (c *Client) GetStatusesByIds(userIds []string) error

func (*Client) SendBinaryMessage

func (c *Client) SendBinaryMessage(action string, data map[string]interface{}) error

SendBinaryMessage is the method to write to the websocket using binary data type (MessagePack encoded).

func (*Client) SendMessage

func (c *Client) SendMessage(action string, data map[string]interface{}) error

SendMessage is the method to write to the websocket.

func (*Client) UserTyping

func (c *Client) UserTyping(channelId, parentId string) error

type ClientParams

type ClientParams struct {
	WsURL          string
	AuthToken      string
	ConnID         string
	ServerSequence int64
}