socket

Documentation

Index

• func GenServer() (*socketio.Server, error)
• type IWrapper
• type Wrapper
  • func NewWrapper(options *engineio.Options) (*Wrapper, error)
  • func NewWrapperWithServer(server *socketio.Server) (*Wrapper, error)
  • func (s *Wrapper) HandlerFunc(context echo.Context) error
  • func (s *Wrapper) OnConnect(nsp string, f func(echo.Context, socketio.Conn) error)
  • func (s *Wrapper) OnDisconnect(nsp string, f func(echo.Context, socketio.Conn, string))
  • func (s *Wrapper) OnError(nsp string, f func(echo.Context, error))
  • func (s *Wrapper) OnEvent(nsp, event string, f func(echo.Context, socketio.Conn, string))

Functions

func GenServer

func GenServer() (*socketio.Server, error)

Types

type IWrapper

type IWrapper interface {
	OnConnect(nsp string, f func(echo.Context, socketio.Conn) error)
	OnDisconnect(nsp string, f func(echo.Context, socketio.Conn, string))
	OnError(nsp string, f func(echo.Context, error))
	OnEvent(nsp, event string, f func(echo.Context, socketio.Conn, string))
	HandlerFunc(context echo.Context) error
}

Socket.io wrapper interface

type Wrapper

type Wrapper struct {
	Context echo.Context
	Server  *socketio.Server
}

func NewWrapper

func NewWrapper(options *engineio.Options) (*Wrapper, error)

Create wrapper and Socket.io server

func NewWrapperWithServer

func NewWrapperWithServer(server *socketio.Server) (*Wrapper, error)

Create wrapper with exists Socket.io server

func (*Wrapper) HandlerFunc

func (s *Wrapper) HandlerFunc(context echo.Context) error

Handler function

func (*Wrapper) OnConnect

func (s *Wrapper) OnConnect(nsp string, f func(echo.Context, socketio.Conn) error)

On Socket.io client connect

func (*Wrapper) OnDisconnect

func (s *Wrapper) OnDisconnect(nsp string, f func(echo.Context, socketio.Conn, string))

On Socket.io client disconnect

func (*Wrapper) OnError

func (s *Wrapper) OnError(nsp string, f func(echo.Context, error))

On Socket.io error

func (*Wrapper) OnEvent

func (s *Wrapper) OnEvent(nsp, event string, f func(echo.Context, socketio.Conn, string))

On Socket.io event from client