node

Oct 9, 2024

Changes in this version

type Config

+ func (c Config) ToToml() string

type DisconnectQueueConfig

+ func (c DisconnectQueueConfig) ToToml() string

Apr 1, 2024

Changes in this version

+ type InlineDisconnector struct

+ func NewInlineDisconnector(n *Node) *InlineDisconnector

+ func (d *InlineDisconnector) Enqueue(s *Session) error

+ func (d *InlineDisconnector) Run() error

+ func (d *InlineDisconnector) Shutdown(ctx context.Context) error

+ func (d *InlineDisconnector) Size() int

type Node

+ func (n *Node) ID() string

+ func (n *Node) Whisper(s *Session, msg *common.Message) error

+ type NodeOption = func(*Node)

+ func WithController(c Controller) NodeOption

+ func WithID(id string) NodeOption

+ func WithInstrumenter(i metrics.Instrumenter) NodeOption

+ func WithLogger(l *slog.Logger) NodeOption

+ type NullController struct

+ func NewNullController(l *slog.Logger) *NullController

+ func (c *NullController) Authenticate(sid string, env *common.SessionEnv) (*common.ConnectResult, error)

+ func (c *NullController) Disconnect(sid string, env *common.SessionEnv, ids string, subscriptions []string) error

+ func (c *NullController) Perform(sid string, env *common.SessionEnv, ids string, channel string, data string) (*common.CommandResult, error)

+ func (c *NullController) Shutdown() (err error)

+ func (c *NullController) Start() (err error)

+ func (c *NullController) Subscribe(sid string, env *common.SessionEnv, ids string, channel string) (*common.CommandResult, error)

+ func (c *NullController) Unsubscribe(sid string, env *common.SessionEnv, ids string, channel string) (*common.CommandResult, error)

Oct 16, 2023

Changes in this version

type Session

+ func (s *Session) String() string

Sep 8, 2023

Changes in this version

type DisconnectQueueConfig

+ Backlog int

type Node

+ func (n *Node) Size() int

type Session

+ func (s *Session) DisconnectNow(reason string, code int)

+ func (s *Session) IsClosed() bool

Aug 11, 2023

Changes in this version

type Config

+ PongTimeout int

type Session

+ func (s *Session) AuthenticateOnConnect() bool

+ func (s *Session) IsResumeable() bool

type SessionOption

+ func WithEncoder(enc encoders.Encoder) SessionOption

+ func WithExecutor(ex Executor) SessionOption

+ func WithHandshakeMessageDeadline(deadline time.Time) SessionOption

+ func WithMetrics(m metrics.Instrumenter) SessionOption

+ func WithPingPrecision(val string) SessionOption

+ func WithPongTimeout(timeout time.Duration) SessionOption

+ func WithPrevSID(sid string) SessionOption

+ func WithResumable(val bool) SessionOption

Aug 4, 2023

Changes in this version

type Config

+ ShutdownDisconnectPoolSize int

+ ShutdownTimeout int

type Node

+ func (n *Node) IsShuttingDown() bool

Jul 8, 2023

Changes in this version

+ const DISCONNECT_MODE_ALWAYS

+ const DISCONNECT_MODE_AUTO

+ const DISCONNECT_MODE_NEVER

+ var DISCONNECT_MODES = []string

type AppNode

+ Authenticated func(s *Session, identifiers string)

+ type AuthOption = func(*AuthOptions)

+ func WithDisconnectOnFailure(disconnect bool) AuthOption

+ type AuthOptions struct

+ DisconnectOnFailure bool

type Config

+ DisconnectMode string

type Node

+ func (n *Node) Authenticated(s *Session, ids string)

+ func (n *Node) ExecuteRemoteCommand(msg *common.RemoteCommandMessage)

+ func (n *Node) HandleBroadcast(raw []byte)

+ func (n *Node) History(s *Session, msg *common.Message) (err error)

+ func (n *Node) Instrumenter() metrics.Instrumenter

+ func (n *Node) SetBroker(b broker.Broker)

+ func (n *Node) TryRestoreSession(s *Session) (restored bool)

type Session

+ func (s *Session) IsConnected() bool

+ func (s *Session) IsDisconnectable() bool

+ func (s *Session) MarkDisconnectable(val bool)

+ func (s *Session) PrevSid() (psid string)

+ func (s *Session) ReadInternalState(key string) (interface{}, bool)

+ func (s *Session) RestoreFromCache(cached []byte) error

+ func (s *Session) ToCacheEntry() ([]byte, error)

+ func (s *Session) UnderlyingConn() Connection

+ func (s *Session) WriteInternalState(key string, val interface{})

+ type SessionOption = func(*Session)

+ func WithPingInterval(interval time.Duration) SessionOption

Mar 1, 2023

Changes in this version

type Session

+ func (s *Session) SetID(id string)

Dec 1, 2022

Changes in this version

type Session

+ func (s *Session) DisconnectWithMessage(msg encoders.EncodedMessage, code string)

+ func (s *Session) GetID() string

+ func (s *Session) GetIdentifiers() string

+ func (s *Session) SetIdentifiers(ids string)

+ func (s *Session) SetIdleTimeout(val time.Duration)

+ type SubscriptionState struct

+ func NewSubscriptionState() *SubscriptionState

+ func (st *SubscriptionState) AddChannel(id string)

+ func (st *SubscriptionState) AddChannelStream(id string, stream string)

+ func (st *SubscriptionState) Channels() []string

+ func (st *SubscriptionState) HasChannel(id string) bool

+ func (st *SubscriptionState) RemoveChannel(id string)

+ func (st *SubscriptionState) RemoveChannelStream(id string, stream string)

+ func (st *SubscriptionState) RemoveChannelStreams(id string) []string

+ func (st *SubscriptionState) StreamsFor(id string) []string

+ func (st *SubscriptionState) ToMap() map[string][]string

Aug 10, 2022

Changes in this version

type Executor

+ Disconnect func(*Session) error

type Session

+ func (s *Session) SetMetrics(m metrics.Instrumenter)

Nov 16, 2021

Changes in this version

type AppNode

+ LookupSession func(id string) *Session

type Node

+ func (n *Node) LookupSession(id string) *Session

type Session

+ InternalState map[string]interface{}

+ func (s *Session) MergeEnv(env *common.SessionEnv)

Jun 23, 2021

Changes in this version

type Session

+ func (s *Session) GetEnv() *common.SessionEnv

+ func (s *Session) SetEnv(env *common.SessionEnv)

Jun 1, 2021

Changes in this version

type AppNode

+ Authenticate func(s *Session) (*common.ConnectResult, error)

+ Disconnect func(s *Session) error

+ Perform func(s *Session, msg *common.Message) (*common.CommandResult, error)

+ Subscribe func(s *Session, msg *common.Message) (*common.CommandResult, error)

+ Unsubscribe func(s *Session, msg *common.Message) (*common.CommandResult, error)

+ type CachedEncodedMessage struct

+ func NewCachedEncodedMessage(msg encoders.EncodedMessage) *CachedEncodedMessage

+ func (msg *CachedEncodedMessage) Fetch(id string, callback EncodingFunction) (*ws.SentFrame, error)

+ func (msg *CachedEncodedMessage) GetType() string

+ func (msg *CachedEncodedMessage) MarshalJSON() ([]byte, error)

type Config

+ HubGopoolSize int

+ PingTimestampPrecision string

+ type Connection interface

+ Close func(code int, reason string)

+ Read func() ([]byte, error)

+ Write func(msg []byte, deadline time.Time) error

+ WriteBinary func(msg []byte, deadline time.Time) error

type Controller

+ Start func() error

+ type EncodingCache struct

+ func NewEncodingCache() *EncodingCache

+ func (m *EncodingCache) Fetch(msg encoders.EncodedMessage, encoder string, callback EncodingFunction) (*ws.SentFrame, error)

+ type EncodingFunction = func(encoders.EncodedMessage) (*ws.SentFrame, error)

+ type Executor interface

+ HandleCommand func(*Session, *common.Message) error

type Session

+ Connected bool

+ func (s *Session) ReadMessage(message []byte) error

+ func (s *Session) SendJSONTransmission(msg string)

+ func (s *Session) Serve(callback func()) error

+ func (s *Session) SetEncoder(enc encoders.Encoder)

+ func (s *Session) SetExecutor(ex Executor)

Mar 17, 2021

Changes in this version

+ type Config struct

+ PingInterval int

+ StatsRefreshInterval int

+ func NewConfig() Config

Mar 4, 2021

Changes in this version

type Hub

+ func (h *Hub) AddSession(s *Session)

+ func (h *Hub) AddSubscription(sid string, identifier string, stream string)

+ func (h *Hub) Broadcast(stream string, data string)

+ func (h *Hub) BroadcastMessage(msg *common.StreamMessage)

+ func (h *Hub) RemoteDisconnect(msg *common.RemoteDisconnectMessage)

+ func (h *Hub) RemoveAllSubscriptions(sid string, identifier string)

+ func (h *Hub) RemoveSession(s *Session)

+ func (h *Hub) RemoveSubscription(sid string, identifier string, stream string)

+ type HubRegistration struct

+ type HubSubscription struct

Jul 7, 2020

Changes in this version

+ func WebsocketHandler(app *Node, fetchHeaders []string, config *WSConfig) http.Handler

+ type AppNode interface

+ HandlePubSub func(msg []byte)

+ type DisconnectQueueConfig struct

+ Rate int

+ ShutdownTimeout int

+ func NewDisconnectQueueConfig() DisconnectQueueConfig

+ type Disconnector interface

+ Enqueue func(*Session) error

+ Run func() error

+ Shutdown func() error

+ Size func() int

type Node

+ func (n *Node) HandlePubSub(raw []byte)

+ func (n *Node) RemoteDisconnect(msg *common.RemoteDisconnectMessage)

+ func (n *Node) SetDisconnector(d Disconnector)

+ func (n *Node) Start()

+ type NoopDisconnectQueue struct

+ func NewNoopDisconnector() *NoopDisconnectQueue

+ func (d *NoopDisconnectQueue) Enqueue(s *Session) error

+ func (d *NoopDisconnectQueue) Run() error

+ func (d *NoopDisconnectQueue) Shutdown() error

+ func (d *NoopDisconnectQueue) Size() int

+ type WSConfig struct

+ EnableCompression bool

+ MaxMessageSize int64

+ ReadBufferSize int

+ WriteBufferSize int

+ func NewWSConfig() WSConfig

Aug 5, 2019

Changes in this version

type CommandResult

+ Broadcasts []*StreamMessage

Mar 25, 2019

Changes in this version

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalServerErr

+ const CloseNormalClosure

+ const PING

+ type CommandResult struct

+ Disconnect bool

+ StopAllStreams bool

+ Streams []string

+ Transmissions []string

+ type Controller interface

+ Authenticate func(sid string, path string, headers *map[string]string) (string, []string, error)

+ Disconnect func(sid string, id string, subscriptions []string, path string, ...) error

+ Perform func(sid string, id string, channel string, data string) (*CommandResult, error)

+ Shutdown func() error

+ Subscribe func(sid string, id string, channel string) (*CommandResult, error)

+ Unsubscribe func(sid string, id string, channel string) (*CommandResult, error)

+ type DisconnectQueue struct

+ func NewDisconnectQueue(node *Node, rate int) *DisconnectQueue

+ func (d *DisconnectQueue) Enqueue(s *Session)

+ func (d *DisconnectQueue) Run()

+ func (d *DisconnectQueue) Shutdown() error

+ func (d *DisconnectQueue) Size() int

+ type Hub struct

+ func NewHub() *Hub

+ func (h *Hub) Run()

+ func (h *Hub) Shutdown()

+ func (h *Hub) Size() int

+ func (h *Hub) StreamsSize() int

+ func (h *Hub) UniqSize() int

+ type Message struct

+ Command string

+ Data string

+ Identifier string

+ type Node struct

+ Config *config.Config

+ Metrics *metrics.Metrics

+ func NewNode(config *config.Config, controller Controller, metrics *metrics.Metrics) *Node

+ func (n *Node) Authenticate(s *Session, path string, headers *map[string]string) error

+ func (n *Node) Broadcast(msg *StreamMessage)

+ func (n *Node) Disconnect(s *Session)

+ func (n *Node) DisconnectNow(s *Session) error

+ func (n *Node) HandleCommand(s *Session, raw []byte)

+ func (n *Node) HandlePubsub(raw []byte)

+ func (n *Node) Perform(s *Session, msg *Message)

+ func (n *Node) Shutdown()

+ func (n *Node) Subscribe(s *Session, msg *Message)

+ func (n *Node) Unsubscribe(s *Session, msg *Message)

+ type Reply struct

+ Identifier string

+ Message interface{}

+ Type string

+ type Session struct

+ Identifiers string

+ Log *log.Entry

+ UID string

+ func NewSession(node *Node, ws *websocket.Conn, request *http.Request) (*Session, error)

+ func (s *Session) Close(reason string, code int)

+ func (s *Session) Disconnect(reason string, code int)

+ func (s *Session) ReadMessages()

+ func (s *Session) Send(msg []byte)

+ func (s *Session) SendMessages(ctx context.Context)

+ type StreamMessage struct

+ Data string

+ Stream string

+ type SubscriptionInfo struct