websocket

Documentation

Overview

Package websocket provides web socket auto configuration for web/cli application

Index

• Constants
• func HandleConnection(constructor HandlerConstructor, conn websocket.Connection)
• type Connection
• type ConnectionFunc
• type Handler
• type HandlerConstructor
• type HandlerFunc
• type Server

Constants

const (
	// Profile websocket profile name
	Profile = "websocket"
	// All is the string which the Emitter use to send a message to all.
	All = ""
	// Broadcast is the string which the Emitter use to send a message to all except this connection.
	Broadcast = ";to;all;except;me;"
)

Functions

func HandleConnection

func HandleConnection(constructor HandlerConstructor, conn websocket.Connection)

Types

type Connection

type Connection interface {
	websocket.Connection
}

Connection is the websocket connection

type ConnectionFunc

type ConnectionFunc func(ctx context.Context) websocket.Connection

type Handler

type Handler interface {
	OnMessage(data []byte)
	OnDisconnect()
}

type HandlerConstructor

type HandlerConstructor func(conn Connection) Handler

ConnectionFunc is the websocket connection function

type HandlerFunc

type HandlerFunc func(ctx *web.Context, constructor HandlerConstructor) Connection

ConnectionFunc is the websocket connection function

type Server

type Server struct {
	*websocket.Server
}