Documentation
¶
Index ¶
Constants ¶
View Source
const (
MetricActiveConnections = "SocketActiveConnections"
)
Variables ¶
View Source
var ( ErrMissingSocketID = errors.New("socket ID is required") ErrMissingNamespace = errors.New("socket namespace is required") ErrUnknownNamespace = errors.New("socket namespace is not registered") )
View Source
var ( ErrSocketClosed = errors.New("socket is closed") ErrSendBufferFull = errors.New("socket send buffer is full") )
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v1.3.244
type Config struct {
WriteWait time.Duration
PongWait time.Duration
PingPeriod time.Duration
MaxMessageSize int64
ReadBufferSize int
WriteBufferSize int
SendBufferSize int
EnableCompression bool
CheckOrigin func(request *http.Request) bool
}
func DefaultConfig ¶ added in v1.3.244
func DefaultConfig() Config
type Connection ¶
type ConnectionOptions ¶ added in v1.3.244
type ConnectionOptions struct {
ID string
Namespace string
Context context.Context
ErrorLogger errorlogger.ErrorLogger
ReadMessageHandler ReadMessageHandler
ResponseHeader http.Header
}
type EventHandlers ¶ added in v0.5.5
type EventHandlers struct {
RegisterHandler, UnregisterHandler func(s *Socket)
}
type NamespaceEventHandlerMap ¶ added in v0.5.5
type NamespaceEventHandlerMap map[string]*EventHandlers
type ReadMessageHandler ¶ added in v1.3.244
type Registry ¶
type Registry struct {
Sockets *sync.Map
ServiceGoroutine goroutine.IGoroutine
// contains filtered or unexported fields
}
func NewSocketRegistry ¶ added in v0.8.78
func NewSocketRegistry(eventHandlersMap NamespaceEventHandlerMap, serviceGoroutine goroutine.IGoroutine) *Registry
func NewSocketRegistryWithConfig ¶ added in v1.3.244
func NewSocketRegistryWithConfig( eventHandlersMap NamespaceEventHandlerMap, serviceGoroutine goroutine.IGoroutine, config Config, ) *Registry
func (*Registry) ServeHTTP ¶ added in v1.3.244
func (registry *Registry) ServeHTTP( writer http.ResponseWriter, request *http.Request, options ConnectionOptions, ) error
ServeHTTP upgrades and owns the connection until it is closed. Authentication must be completed by the caller before this method is invoked.
type Socket ¶
type Socket struct {
Ctx context.Context
ErrorLogger errorlogger.ErrorLogger
Connection *Connection
ID string
Namespace string
// contains filtered or unexported fields
}
Click to show internal directories.
Click to hide internal directories.