websocket

Documentation

Index

• type CloseEvent
  • func CloseEventOf(x js.Value) *CloseEvent
  • func (e *CloseEvent) Code() uint16
  • func (e *CloseEvent) Reason() string
  • func (e *CloseEvent) WasClean() bool
• type State
  • func (s State) String() string
• type WebSocket
  • func Connect(url string) *WebSocket
  • func (ws *WebSocket) Close()
  • func (ws *WebSocket) Closed() bool
  • func (ws *WebSocket) OnClose(cb func(*CloseEvent)) *WebSocket
  • func (ws *WebSocket) OnError(cb func(*js.Event)) *WebSocket
  • func (ws *WebSocket) OnMessage(cb func([]byte)) *WebSocket
  • func (ws *WebSocket) OnOpen(cb func(*js.Event)) *WebSocket
  • func (ws *WebSocket) ReadyState() State
  • func (ws *WebSocket) Release()
  • func (ws *WebSocket) SendBinary(data interface{}) *WebSocket
  • func (ws *WebSocket) SendText(data string) *WebSocket
  • func (ws *WebSocket) URL() string

Types

type CloseEvent

type CloseEvent struct {
	*js.Event
}

CloseEvent represents javascript close event. https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent.

func CloseEventOf

func CloseEventOf(x js.Value) *CloseEvent

CloseEventOf returns a close event.

func (*CloseEvent) Code

func (e *CloseEvent) Code() uint16

Code returns close code from server.

func (*CloseEvent) Reason

func (e *CloseEvent) Reason() string

Reason returns eht reason the server closed the connection.

func (*CloseEvent) WasClean

func (e *CloseEvent) WasClean() bool

WasClean returns a boolean that indicates whether or not the connection was cleanly closed.

type State

type State uint16

State represents websocket ready state.

const (
	Connecting State = 0
	Open       State = 1
	Closing    State = 2
	Closed     State = 3
)

websocket ready state valeus.

func (State) String

func (s State) String() string

type WebSocket

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

WebSocket represents javascript web socket component.

func Connect

func Connect(url string) *WebSocket

Connect connects to server.

func (*WebSocket) Close

func (ws *WebSocket) Close()

Close closes the connection.

func (*WebSocket) Closed

func (ws *WebSocket) Closed() bool

Closed returns boolean that indicates whether or not the connection was closed.

func (*WebSocket) OnClose

func (ws *WebSocket) OnClose(cb func(*CloseEvent)) *WebSocket

OnClose add callback function when closed.

func (*WebSocket) OnError

func (ws *WebSocket) OnError(cb func(*js.Event)) *WebSocket

OnError add callback function when error happening.

func (*WebSocket) OnMessage

func (ws *WebSocket) OnMessage(cb func([]byte)) *WebSocket

OnMessage add callback function when receiving message.

func (*WebSocket) OnOpen

func (ws *WebSocket) OnOpen(cb func(*js.Event)) *WebSocket

OnOpen add callback function when opening.

func (*WebSocket) ReadyState

func (ws *WebSocket) ReadyState() State

ReadyState returns current ready state.

func (*WebSocket) Release

func (ws *WebSocket) Release()

Release closes connection and frees up resources.

func (*WebSocket) SendBinary

func (ws *WebSocket) SendBinary(data interface{}) *WebSocket

SendBinary sends binary data to server. Parameter data must be []int8, []int16, []int32, []uint8, []uint16, []uint32, []float32 and []float64.

func (*WebSocket) SendText

func (ws *WebSocket) SendText(data string) *WebSocket

SendText sends text message to server.

func (*WebSocket) URL

func (ws *WebSocket) URL() string

URL returns current connecting url.