uwebsocket

Nov 27, 2023

Changes in this version

type SendOption

+ func WithClientFilter(clientGUID string) SendOption

+ func WithFlagFilter(flag string) SendOption

+ func WithMatchFilter(key string, value string) SendOption

type WebSocketClient

+ Attributes func() *ClientAttributes

+ Cancel func()

+ ClientGUID func() string

+ Ctx func() context.Context

+ Handler func() Handler

+ Request func() *http.Request

+ Run func(ctx context.Context)

+ SendChan func() chan []byte

+ type WebSocketClientMock struct

+ func NewWebSocketClientMock(t *testing.T, ctx context.Context, guid string, attrs *ClientAttributes) *WebSocketClientMock

+ func (c *WebSocketClientMock) Attributes() *ClientAttributes

+ func (c *WebSocketClientMock) Cancel()

+ func (c *WebSocketClientMock) ClientGUID() string

+ func (c *WebSocketClientMock) Ctx() context.Context

+ func (c *WebSocketClientMock) Handler() Handler

+ func (c *WebSocketClientMock) Request() *http.Request

+ func (c *WebSocketClientMock) Run(ctx context.Context)

+ func (c *WebSocketClientMock) SendChan() chan []byte

Nov 27, 2023

Changes in this version

+ type SendOption func(*sendOptions)

+ func WithAsync() SendOption

+ func WithFilterFn(fn func(clientGUID string, attrs *ClientAttributes) bool) SendOption

+ func WithMessage(message []byte) SendOption

+ func WithMessageFn(fn func(string, *ClientAttributes) ([]byte, error)) SendOption

type WebSocketHub

+ func (h *WebSocketHub) Send(ctx context.Context, opts ...SendOption) error

Nov 23, 2023

Changes in this version

type WebSocketHub

+ func (h *WebSocketHub) CountClientsWithFilter(filterFunc func(clientGUID string, attrs *ClientAttributes) bool) int

Mar 13, 2021

Changes in this version

type HandlerOption

+ func WithOnDisconnect(...) HandlerOption

Sep 9, 2020

Changes in this version

type WebSocketHub

+ func (h *WebSocketHub) SendToClient(clientGUID string, message []byte, ctx context.Context) error

Nov 16, 2023

Changes in this version

type Handler

+ func NewHandler(opts ...HandlerOption) Handler

+ type HandlerOption interface

+ func WithClientAttributes(f func(hub *WebSocketHub, r *http.Request) (*ClientAttributes, error)) HandlerOption

+ func WithOnConnect(...) HandlerOption

+ func WithOnError(...) HandlerOption

+ func WithOnIncomingMessage(...) HandlerOption

+ func WithUhttpHandler(h uhttp.Handler) HandlerOption

+ func WithWelcomeMessages(...) HandlerOption

type WebSocketHub

+ func (h *WebSocketHub) SendToAllWithFlagAsync(flag string, message []byte, ctx context.Context)

+ func (h *WebSocketHub) SendToAllWithMatchAsync(key string, value string, message []byte, ctx context.Context)

+ func (h *WebSocketHub) SendWithFilterAsync(filterFunc func(clientGUID string, attrs *ClientAttributes) bool, ...)

Feb 5, 2021

Changes in this version

+ var ErrClientNotFound = errors.New("client not found")

+ var KEY_DOES_NOT_EXIST_ERR = errors.New("key does not exist")

+ var KEY_HAS_WRONG_TYPE_ERR = errors.New("key has wrong type")

+ func WelcomeMessages(...) ...

type ClientAttributes

+ func NewClientAttributes() *ClientAttributes

+ func (c *ClientAttributes) GetBool(key string) (bool, error)

+ func (c *ClientAttributes) GetString(key string) (string, error)

+ func (c *ClientAttributes) SetBool(key string, value bool) *ClientAttributes

+ func (c *ClientAttributes) SetString(key string, value string) *ClientAttributes

+ func (c *ClientAttributes) String() string

type ClientMessage

+ ClientAttributes *ClientAttributes

+ ClientGUID string

type Handler

+ WelcomeMessages *func(hub *WebSocketHub, clientGuid string, clientAttributes *ClientAttributes, r *http.Request) ([][]byte, error)

type WebSocketHub

+ func (h *WebSocketHub) SendToAllWithFlagSync(flag string, message []byte, ctx context.Context) error

+ func (h *WebSocketHub) SendToAllWithMatchSync(key string, value string, message []byte, ctx context.Context) error

+ func (h *WebSocketHub) SendToClientSync(clientGUID string, message []byte, ctx context.Context) error

+ func (h *WebSocketHub) SendWithFilterSync(filterFunc func(clientGUID string, attrs *ClientAttributes) bool, ...) error

Sep 9, 2020

Changes in this version

+ func WelcomeMessage(...) ...

type Handler

+ WelcomeMessage *func(hub *WebSocketHub, clientGuid string, clientAttributes ClientAttributes, r *http.Request) ([]byte, error)

May 27, 2020

Changes in this version

type ClientAttributes

+ func (c ClientAttributes) HasMatch(key string, value string) bool

+ func (c ClientAttributes) IsFlagSet(key string) bool

Oct 4, 2019

Changes in this version

+ func OnDisconnect(...) *func(hub *WebSocketHub, clientAttributes ClientAttributes, err error)

+ func OnError(onErrorFunc func(err error)) *func(err error)

type Handler

+ OnDisconnect *func(hub *WebSocketHub, clientAttributes ClientAttributes, err error)

+ OnError *func(err error)

Oct 4, 2019

Changes in this version

+ func ClientAttributesFunc(...) *func(hub *WebSocketHub, r *http.Request) (ClientAttributes, error)

Oct 3, 2019

Changes in this version

+ func OnConnect(onConnectFunc func(r *http.Request)) *func(r *http.Request)

+ func SetConfig(_config Config)

+ func UpgradeConnection(hub *WebSocketHub, clientAttributes ClientAttributes, w http.ResponseWriter, ...) error

+ type ClientAttributes interface

+ type ClientMessage struct

+ Client ClientAttributes

+ Message []byte

+ type Config struct

+ CORS *string

+ CustomLog ulog.ULogger

+ func GetConfig() Config

+ type Handler struct

+ ClientAttributes ClientAttributes

+ OnConnect *func(r *http.Request)

+ UhttpHandler uhttp.Handler

+ type WebSocketClient struct

+ type WebSocketHub struct

+ func CreateHubAndRunInBackground(messagHandler *chan ClientMessage) *WebSocketHub

+ func NewWebSocketHub(messagHandler *chan ClientMessage) *WebSocketHub

+ func (h *WebSocketHub) Handle(pattern string, handler *Handler)

+ func (h *WebSocketHub) Run()

+ func (h *WebSocketHub) SendWithFilter(filterFunc func(attrs ClientAttributes) bool, message []byte) error