socket

Documentation

Index

• type PescaSocket
  • func EnhanceSocket(c *websocket.Conn, channel typings.GeneralChannel) *PescaSocket
  • func (s *PescaSocket) Bind()
  • func (s *PescaSocket) Close(code int, text string)
  • func (s *PescaSocket) GetConn() *websocket.Conn
  • func (s PescaSocket) GetID() string
  • func (s *PescaSocket) IsLoggedIn() bool
  • func (s *PescaSocket) Send(event string, payload interface{})
  • func (s *PescaSocket) Start()

Types

type PescaSocket

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

PescaSocket is a wrapper around a classic websocket connection.

func EnhanceSocket

func EnhanceSocket(c *websocket.Conn, channel typings.GeneralChannel) *PescaSocket

EnhanceSocket returns a wrapper around a classic websocket connection.

func (*PescaSocket) Bind

func (s *PescaSocket) Bind()

Bind all relevant things for PescaSocket.

func (*PescaSocket) Close

func (s *PescaSocket) Close(code int, text string)

Close the socket and send error message to user.

func (*PescaSocket) GetConn

func (s *PescaSocket) GetConn() *websocket.Conn

GetConn returns the current connection.

func (PescaSocket) GetID

func (s PescaSocket) GetID() string

GetID returns the id of this PescaSocket.

func (*PescaSocket) IsLoggedIn

func (s *PescaSocket) IsLoggedIn() bool

IsLoggedIn returns true if the current socket is logged in, false otherwise.

func (*PescaSocket) Send

func (s *PescaSocket) Send(event string, payload interface{})

Send an event + payload message of the websocket.

func (*PescaSocket) Start

func (s *PescaSocket) Start()

Start starts . :))