wsio

Documentation

Index

• Constants
• func AckError(msg string) string
• func AckResp(msg string) string
• func SetAdapter(adaptor SignalingAdaptor) error
• func SetHandlers(auth AuthHandler, conn ConnectHandler, disc DisconnectHandler)
• type AuthHandler
• type ConnectHandler
• type DisconnectHandler
• type EventAck
• type SignalingAdaptor
• type SignalingEvent

Constants

const (
	// StSuccess success status
	StSuccess = iota + 1

	// StError error status
	StError
)

Functions

func AckError

func AckError(msg string) string

Response error ack to socket client

func AckResp

func AckResp(msg string) string

Response normal ack to socket client

func SetAdapter

func SetAdapter(adaptor SignalingAdaptor) error

Set adapter to register socket signaling events.

func SetHandlers

func SetHandlers(auth AuthHandler, conn ConnectHandler, disc DisconnectHandler)

Set handler to execute clients authenticate, connect and disconnect.

Types

type AuthHandler

type AuthHandler func(token string) (string, string, error)

Auth client outset, it will disconnect when return no-nil error

@param token client login jwt-token contain uuid or optional data in claims key string
@return - string client uuid
		- any client optional data parsed from token
		- error Exception message

type ConnectHandler

type ConnectHandler func(uuid, option string) error

Client connected callback, it will disconnect when return no-nil error

@param uuid client unique id
@param option client login optional data, maybe nil
@return - error Exception message

type DisconnectHandler

type DisconnectHandler func(uuid, option string)

Client disconnected handler function

@param uuid client unique id
@param option client login optional data, maybe nil

`NOTICE` :

The client of uuid already released when call this event function.

type EventAck

type EventAck struct {
	State   int    `json:"state"`
	Message string `json:"message"`
}

Socket event ack

type SignalingAdaptor

type SignalingAdaptor interface {

	// Retruen socket signaling events
	Signalings() []string

	// Dispath socket signaling callback by event
	Dispatch(evt string) SignalingEvent
}

Socket signaling adaptor to register events

type SignalingEvent

type SignalingEvent func(sc sio.Socket, uuid, params string) string

Socket signlaing event function