websocket

package module

Go to main page

Versions in this module

v0

v0.2.0

Nov 2, 2018

Changes in this version

+ const CloseMessage

+ const DefaultEvtMessageKey

+ const WriteWait

+ var ErrAlreadyDisconnected = errors.New("already disconnected")

+ func ClientHandler(w http.ResponseWriter, r *http.Request)

type Config

+ EnableCompression bool

+ EvtMessagePrefix []byte

+ HandshakeTimeout time.Duration

+ Subprotocols []string

type Connection

+ Err func() error

+ FireOnError func(err error)

+ GetValue func(key string) interface{}

+ GetValueArrString func(key string) []string

+ GetValueInt func(key string) int

+ GetValueString func(key string) string

+ IsJoined func(roomName string) bool

+ OnLeave func(roomLeaveCb LeaveRoomFunc)

+ OnPing func(PingFunc)

+ OnPong func(PongFunc)

+ Request func() *http.Request

+ Server func() *Server

+ SetValue func(key string, value interface{})

+ Wait func()

+ Write func(websocketMessageType int, data []byte) error

+ type ConnectionValues []connectionValue

+ func (r *ConnectionValues) Get(key string) interface{}

+ func (r *ConnectionValues) Reset()

+ func (r *ConnectionValues) Set(key string, value interface{})

+ type LeaveRoomFunc func(roomName string)

+ type PingFunc func()

+ type PongFunc func()

type Server

+ ClientSource []byte

+ func (s *Server) GetConnection(connID string) Connection

+ func (s *Server) GetConnections() []Connection

+ func (s *Server) GetConnectionsByRoom(roomName string) []Connection

+ func (s *Server) GetTotalConnections() (n int)

+ func (s *Server) IsJoined(roomName string, connID string) bool

+ func (s *Server) Upgrade(w http.ResponseWriter, r *http.Request) Connection

v0.0.3

Feb 7, 2017

Changes in this version

+ const DefaultWebsocketReadTimeout

+ var DefaultIDGenerator = func(*http.Request) string

+ func Disconnect(connID string) error

+ func IsConnected(connID string) bool

+ func Join(roomName string, connID string)

+ func Leave(roomName string, connID string)

+ func LeaveAll(connID string)

type Config

+ IDGenerator func(*http.Request) string

+ ReadTimeout time.Duration

+ type Emitter interface

+ Emit func(string, interface{}) error

+ EmitMessage func([]byte) error

type OptionSet

+ func IDGenerator(val func(*http.Request) string) OptionSet

+ func ReadTimeout(val time.Duration) OptionSet

type Server

+ Disconnect func(connID string) error

+ IsConnected func(connID string) bool

+ Join func(roomName string, connID string)

+ Leave func(roomName string, connID string)

+ LeaveAll func(connID string)

type UnderlineConnection

+ SetPingHandler func(h func(appData string) error)

+ WriteControl func(messageType int, data []byte, deadline time.Time) error

v0.0.2

Nov 4, 2016

Changes in this version

+ const All

+ const Broadcast

+ const ClientSourcePath

+ const DefaultWebsocketMaxMessageSize

+ const DefaultWebsocketPingPeriod

+ const DefaultWebsocketPongTimeout

+ const DefaultWebsocketReadBufferSize

+ const DefaultWebsocketWriteTimeout

+ const DefaultWebsocketWriterBufferSize

+ const NotMe

+ const Version

+ var ClientSource = []byte(...)

+ var ClientSourceHandler = fs.StaticContentHandler(ClientSource, "application/javascript")

+ func HandleConnection(websocketConn UnderlineConnection)

+ func Handler() http.Handler

+ func OnConnection(cb ConnectionFunc)

+ func Random(n int) []byte

+ func RandomString(n int) string

+ func Serve()

+ func Set(setters ...OptionSetter)

+ type Config struct

+ BinaryMessages bool

+ CheckOrigin func(req *http.Request) bool

+ Error func(res http.ResponseWriter, req *http.Request, status int, reason error)

+ MaxMessageSize int64

+ PingPeriod time.Duration

+ PongTimeout time.Duration

+ ReadBufferSize int

+ WriteBufferSize int

+ WriteTimeout time.Duration

+ func (c Config) Set(main *Config)

+ func (c Config) Validate() Config

+ type Connection interface

+ Disconnect func() error

+ EmitError func(errorMessage string)

+ ID func() string

+ Join func(string)

+ Leave func(string)

+ On func(string, MessageFunc)

+ OnDisconnect func(DisconnectFunc)

+ OnError func(ErrorFunc)

+ OnMessage func(NativeMessageFunc)

+ To func(string) Emmiter

+ type ConnectionFunc func(Connection)

+ type DisconnectFunc func()

+ type Emmiter interface

+ Emit func(string, interface{}) error

+ EmitMessage func([]byte) error

+ type ErrorFunc (func(string))

+ type MessageFunc interface

+ type NativeMessageFunc func([]byte)

+ type OptionSet func(c *Config)

+ func BinaryMessages(val bool) OptionSet

+ func CheckOrigin(val func(req *http.Request) bool) OptionSet

+ func Error(val func(res http.ResponseWriter, req *http.Request, status int, reason error)) OptionSet

+ func MaxMessageSize(val int64) OptionSet

+ func PingPeriod(val time.Duration) OptionSet

+ func PongTimeout(val time.Duration) OptionSet

+ func ReadBufferSize(val int) OptionSet

+ func WriteBufferSize(val int) OptionSet

+ func WriteTimeout(val time.Duration) OptionSet

+ func (o OptionSet) Set(c *Config)

+ type OptionSetter interface

+ Set func(c *Config)

+ type Rooms map[string][]string

+ type Server interface

+ HandleConnection func(UnderlineConnection)

+ Handler func() http.Handler

+ OnConnection func(cb ConnectionFunc)

+ Serve func()

+ Set func(...OptionSetter)

+ func New(setters ...OptionSetter) Server

+ type UnderlineConnection interface

+ Close func() error

+ NextWriter func(messageType int) (io.WriteCloser, error)

+ ReadMessage func() (messageType int, p []byte, err error)

+ SetPongHandler func(h func(appData string) error)

+ SetReadDeadline func(t time.Time) error

+ SetReadLimit func(limit int64)

+ SetWriteDeadline func(t time.Time) error

+ WriteMessage func(messageType int, data []byte) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL