wsclient

Documentation

Index

• type WebSocketClient
  • func NewWebSocketClient(conf *WebSocketConfig) *WebSocketClient
  • func (wcc *WebSocketClient) Init() error
  • func (wcc *WebSocketClient) Notify(authInfo map[string]string)
  • func (wcc *WebSocketClient) Receive() (model.Message, error)
  • func (wcc *WebSocketClient) Send(message model.Message) error
  • func (wcc *WebSocketClient) Uninit()
• type WebSocketConfig

Types

type WebSocketClient

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

WebSocketClient defines websocket client object

func NewWebSocketClient

func NewWebSocketClient(conf *WebSocketConfig) *WebSocketClient

NewWebSocketClient returns a new web socket client object with its configuration

func (*WebSocketClient) Init

func (wcc *WebSocketClient) Init() error

Init initializes websocket client

func (*WebSocketClient) Notify

func (wcc *WebSocketClient) Notify(authInfo map[string]string)

Notify logs info

func (*WebSocketClient) Receive

func (wcc *WebSocketClient) Receive() (model.Message, error)

Receive reads the binary message through the connection

func (*WebSocketClient) Send

func (wcc *WebSocketClient) Send(message model.Message) error

Send sends the message as binary message through the connection

func (*WebSocketClient) Uninit

func (wcc *WebSocketClient) Uninit()

Uninit closes the web socket connection

type WebSocketConfig

type WebSocketConfig struct {
	URL              string
	CertFilePath     string
	KeyFilePath      string
	HandshakeTimeout time.Duration
	ReadDeadline     time.Duration
	WriteDeadline    time.Duration
	ExtendHeader     http.Header
}

WebSocketConfig defines configuration object