uwebsocket

Documentation

Index

• Variables
• type ClientAttributes
  • func NewClientAttributes() *ClientAttributes
  • func (c *ClientAttributes) GetBool(key string) (bool, error)
  • func (c *ClientAttributes) GetString(key string) (string, error)
  • func (c *ClientAttributes) HasMatch(key string, value string) bool
  • func (c *ClientAttributes) IsFlagSet(key string) bool
  • 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
• type Handler
  • func NewHandler(opts ...HandlerOption) Handler
• type HandlerOption
  • 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 SendOption
  • func WithClientFilter(clientGUID string) SendOption
  • func WithFilterFn(fn func(clientGUID string, attrs *ClientAttributes) bool) SendOption
  • func WithFlagFilter(flag string) SendOption
  • func WithMatchFilter(key string, value string) SendOption
  • func WithMessage(message []byte) SendOption
  • func WithMessageFn(fn func() ([]byte, error)) SendOption
• type WebSocketClient
• type WebSocketClientMock
  • 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
• type WebSocketHub
  • func CreateHubAndRunInBackground(u *uhttp.UHTTP, messageType int, ctx context.Context) *WebSocketHub
  • func NewWebSocketHub(u *uhttp.UHTTP, messageType int, ctx context.Context) *WebSocketHub
  • func (h *WebSocketHub) CountClientsWithFilter(filterFunc func(clientGUID string, attrs *ClientAttributes) bool) int
  • func (h *WebSocketHub) Handle(pattern string, handler Handler)
  • func (h *WebSocketHub) Run()
  • func (h *WebSocketHub) Send(opts ...SendOption)

Variables

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")

Types

type ClientAttributes

type ClientAttributes struct {
	// contains filtered or unexported fields
}

func NewClientAttributes

func NewClientAttributes() *ClientAttributes

func (*ClientAttributes) GetBool

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

func (*ClientAttributes) GetString

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

func (*ClientAttributes) HasMatch

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

func (*ClientAttributes) IsFlagSet

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

func (*ClientAttributes) SetBool

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

func (*ClientAttributes) SetString

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

func (*ClientAttributes) String

func (c *ClientAttributes) String() string

type ClientMessage

type ClientMessage struct {
	ClientGUID string
	Message    []byte
}

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(opts ...HandlerOption) Handler

type HandlerOption

type HandlerOption interface {
	// contains filtered or unexported methods
}

func WithClientAttributes

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

func WithOnConnect

func WithOnConnect(f func(hub *WebSocketHub, clientGuid string, clientAttributes *ClientAttributes, r *http.Request, ctx context.Context)) HandlerOption

func WithOnError

func WithOnError(f func(hub *WebSocketHub, clientGuid string, clientAttributes *ClientAttributes, r *http.Request, err error, ctx context.Context)) HandlerOption

func WithOnIncomingMessage

func WithOnIncomingMessage(f func(hub *WebSocketHub, clientGuid string, clientAttributes *ClientAttributes, r *http.Request, msg ClientMessage, ctx context.Context)) HandlerOption

func WithUhttpHandler

func WithUhttpHandler(h uhttp.Handler) HandlerOption

func WithWelcomeMessages

func WithWelcomeMessages(f func(hub *WebSocketHub, clientGuid string, clientAttributes *ClientAttributes, r *http.Request, ctx context.Context) ([][]byte, error)) HandlerOption

type SendOption

type SendOption func(*sendOptions)

func WithClientFilter

func WithClientFilter(clientGUID string) SendOption

func WithFilterFn

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

Specify the filter function to be called for each client

func WithFlagFilter

func WithFlagFilter(flag string) SendOption

func WithMatchFilter

func WithMatchFilter(key string, value string) SendOption

func WithMessage

func WithMessage(message []byte) SendOption

Specify the message to send

func WithMessageFn

func WithMessageFn(fn func() ([]byte, error)) SendOption

Specify the function to be called for generating the massage if the filter function returns true

type WebSocketClient

type WebSocketClient interface {
	ClientGUID() string
	Attributes() *ClientAttributes
	SendChan() chan []byte
	Ctx() context.Context
	Cancel()
	Handler() Handler
	Request() *http.Request
	Run(ctx context.Context)
}

type WebSocketClientMock

type WebSocketClientMock struct {
	// contains filtered or unexported fields
}

func NewWebSocketClientMock

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

func (*WebSocketClientMock) Attributes

func (c *WebSocketClientMock) Attributes() *ClientAttributes

func (*WebSocketClientMock) Cancel

func (c *WebSocketClientMock) Cancel()

func (*WebSocketClientMock) ClientGUID

func (c *WebSocketClientMock) ClientGUID() string

func (*WebSocketClientMock) Ctx

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

func (*WebSocketClientMock) Handler

func (c *WebSocketClientMock) Handler() Handler

func (*WebSocketClientMock) Request

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

func (*WebSocketClientMock) Run

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

func (*WebSocketClientMock) SendChan

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

type WebSocketHub

type WebSocketHub struct {
	// contains filtered or unexported fields
}

func CreateHubAndRunInBackground

func CreateHubAndRunInBackground(u *uhttp.UHTTP, messageType int, ctx context.Context) *WebSocketHub

func NewWebSocketHub

func NewWebSocketHub(u *uhttp.UHTTP, messageType int, ctx context.Context) *WebSocketHub

func (*WebSocketHub) CountClientsWithFilter

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

func (*WebSocketHub) Handle

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

func (*WebSocketHub) Run

func (h *WebSocketHub) Run()

func (*WebSocketHub) Send

func (h *WebSocketHub) Send(opts ...SendOption)

Pushes a message into the hub, there are no guarantees regarding message delivery

• evaluates the filter, if no subscribers exist: return immediately
• generates message once, and then caches it (if a messageFn is provided)
• pumps the message into the send-channel of all matching clients
• if the client-buffer is full, the message is discarded
• the function always returns immediately