wsconn

Documentation

Index

• type Payload
  • func (p Payload) String() string
• type WebsocketConn
  • func New(ws *websocket.Conn) *WebsocketConn
  • func (ws *WebsocketConn) Close() (err error)
  • func (ws *WebsocketConn) Receive() (p Payload, err error)
  • func (ws *WebsocketConn) Send(p Payload) (err error)

Types

type Payload

type Payload struct {
	Success   bool   `json:"success"`
	Type      string `json:"type,omitempty"`
	Message   string `json:"message,omitempty"`
	IPAddress string `json:"ip,omitempty"`
	Key       string `json:"key,omitempty"`
}

Payload lists the data exchanged

func (Payload) String

func (p Payload) String() string

type WebsocketConn

type WebsocketConn struct {
	sync.Mutex
	// contains filtered or unexported fields
}

WebsocketConn provides convenience functions for sending and receiving data with websockets, using mutex to make sure only one writer/reader

func New

func New(ws *websocket.Conn) *WebsocketConn

NewWebsocket returns a new websocket

func (*WebsocketConn) Close

func (ws *WebsocketConn) Close() (err error)

func (*WebsocketConn) Receive

func (ws *WebsocketConn) Receive() (p Payload, err error)

func (*WebsocketConn) Send

func (ws *WebsocketConn) Send(p Payload) (err error)