sckio

Documentation

Index

• func New(name string) *sckServer
• func NewAppSocket(s Socket, user sdkcm.Requester) *appSocket
• type AppSocket
• type Config
• type ObserverProvider
• type Socket
• type SocketServer

Functions

func New

func New(name string) *sckServer

func NewAppSocket

func NewAppSocket(s Socket, user sdkcm.Requester) *appSocket

Types

type AppSocket

type AppSocket interface {
	CurrentUser() sdkcm.Requester
	Socket
}

type Config

type Config struct {
	Name          string
	MaxConnection int
}

type ObserverProvider

type ObserverProvider interface {
	AddObservers(server *socketio.Server, sc goservice.ServiceContext, l logger.Logger) func(socketio.Conn) error
}

type Socket

type Socket interface {
	ID() string
	Close() error
	URL() url.URL
	LocalAddr() net.Addr
	RemoteAddr() net.Addr
	RemoteHeader() http.Header

	Context() interface{}
	SetContext(v interface{})
	Namespace() string
	Emit(msg string, v ...interface{})

	Join(room string)
	Leave(room string)
	LeaveAll()
	Rooms() []string
}

type SocketServer

type SocketServer interface {
	UserSockets(userId int) []AppSocket
	EmitToRoom(room string, key string, data interface{}) error
	EmitToUser(userId int, key string, data interface{}) error
	StartRealtimeServer(engine *gin.Engine, sc goservice.ServiceContext, op ObserverProvider)
	GetSocketServer() *socketio.Server
	SaveAppSocket(userId int, appSck AppSocket)
}