centrifuge

Dec 21, 2024

Changes in this version

type Client

+ func (c *Client) ConnectNoErrorToDisconnect(req ConnectRequest) error

type CommandProcessedEvent

+ Error error

type Config

+ UnidirectionalCodeToDisconnect map[uint32]Disconnect

Aug 10, 2024

Changes in this version

type RedisPresenceManagerConfig

+ UseHashFieldTTL bool

Jul 26, 2024

Changes in this version

+ type CacheEmptyEvent struct

+ Channel string

+ type CacheEmptyHandler func(CacheEmptyEvent) (CacheEmptyReply, error)

+ type CacheEmptyReply struct

+ Populated bool

+ type ChannelMediumOptions struct

+ KeepLatestPublication bool

+ SharedPositionSync bool

type Config

+ ClientChannelPositionMaxTimeLag time.Duration

+ ClientConnectIncludeServerTime bool

+ GetBroker func(channel string) (Broker, bool)

+ GetChannelMediumOptions func(channel string) ChannelMediumOptions

+ GetPresenceManager func(channel string) (PresenceManager, bool)

+ type DeltaType string

+ const DeltaTypeFossil

type Node

+ func (n *Node) HandleControl(data []byte) error

+ func (n *Node) HandleJoin(ch string, info *ClientInfo) error

+ func (n *Node) HandleLeave(ch string, info *ClientInfo) error

+ func (n *Node) HandlePublication(ch string, pub *Publication, sp StreamPosition, delta bool, ...) error

+ func (n *Node) OnCacheEmpty(h CacheEmptyHandler)

type Publication

+ Channel string

+ Time int64

type PublishOption

+ func WithDelta(enabled bool) PublishOption

type PublishOptions

+ UseDelta bool

+ type RecoveryMode uint8

+ const RecoveryModeCache

+ const RecoveryModeStream

type SubscribeOption

+ func WithRecoveryMode(mode RecoveryMode) SubscribeOption

type SubscribeOptions

+ AllowedDeltaTypes []DeltaType

+ RecoveryMode RecoveryMode

type WebsocketConfig

+ CompressionPreparedMessageCacheSize int64

Mar 2, 2024

Changes in this version

type PublishOption

+ func WithIdempotencyKey(key string) PublishOption

+ func WithIdempotentResultTTL(ttl time.Duration) PublishOption

type PublishOptions

+ IdempotencyKey string

+ IdempotentResultTTL time.Duration

type PublishResult

+ FromCache bool

type RedisBrokerConfig

+ SkipPubSub bool

type RedisPresenceManagerConfig

+ EnableUserMapping func(channel string) bool

Oct 30, 2023

Changes in this version

type Config

+ ChannelNamespaceLabelForTransportMessagesReceived bool

+ ChannelNamespaceLabelForTransportMessagesSent bool

+ GetChannelNamespaceLabel func(channel string) string

type TransportWriteEvent

+ Channel string

+ FrameType protocol.FrameType

Oct 9, 2023

Changes in this version

type Client

+ func (c *Client) WritePublication(channel string, publication *Publication, sp StreamPosition) error

type SubscribeReply

+ SubscriptionReady chan struct{}

Jun 15, 2023

Changes in this version

type Client

+ func (c *Client) AcquireStorage() (map[string]any, func(map[string]any))

type ConnectReply

+ Storage map[string]any

Mar 26, 2023

Changes in this version

type Config

+ HistoryMetaTTL time.Duration

type ConnectReply

+ PingPongConfig *PingPongConfig

type HistoryOption

+ func WithHistoryFilter(filter HistoryFilter) HistoryOption

+ func WithHistoryMetaTTL(metaTTL time.Duration) HistoryOption

type HistoryOptions

+ Filter HistoryFilter

+ MetaTTL time.Duration

type PublishOptions

+ HistoryMetaTTL time.Duration

type SubscribeOption

+ func WithSubscribeHistoryMetaTTL(metaTTL time.Duration) SubscribeOption

type SubscribeOptions

+ HistoryMetaTTL time.Duration

type TransportInfo

+ PingPongConfig func() PingPongConfig

Apr 15, 2023

Changes in this version

type RedisShardConfig

+ ForceRESP2 bool

Jan 20, 2023

Changes in this version

+ var DisableProtocolVersion1 bool

+ var DisconnectNotAvailable = Disconnect

+ var DisconnectPermissionDenied = Disconnect

+ var DisconnectTooManyErrors = Disconnect

+ var DisconnectTooManyRequests = Disconnect

+ func HandleReadFrame(c *Client, r io.Reader) bool

+ type CommandProcessedEvent struct

+ Command *protocol.Command

+ Disconnect *Disconnect

+ Reply *protocol.Reply

+ Started time.Time

+ type CommandProcessedHandler func(*Client, CommandProcessedEvent)

type CommandReadEvent

+ CommandSize int

type ConnectReply

+ MaxMessagesInFrame int

+ QueueInitialCap int

+ ReplyWithoutQueue bool

+ WriteDelay time.Duration

type Node

+ func (n *Node) OnCommandProcessed(handler CommandProcessedHandler)

type RedisShardConfig

+ ClientName string

+ IOTimeout time.Duration

+ SentinelClientName string

+ SentinelTLSConfig *tls.Config

Nov 11, 2022

Changes in this version

+ var DisconnectInappropriateProtocol = Disconnect

+ type CommandReadEvent struct

+ Command *protocol.Command

+ type CommandReadHandler func(*Client, CommandReadEvent)

type Node

+ func (n *Node) OnCommandRead(handler CommandReadHandler)

Sep 7, 2022

Changes in this version

type ChannelContext

+ Source uint8

type Client

+ func (c *Client) ChannelsWithContext() map[string]ChannelContext

+ type PingPongConfig struct

+ PingInterval time.Duration

+ PongTimeout time.Duration

type RedisBroker

+ func (b *RedisBroker) Close(_ context.Context) error

type RedisPresenceManager

+ func (m *RedisPresenceManager) Close(_ context.Context) error

type RedisShard

+ func (s *RedisShard) Close()

type SubscribeOption

+ func WithSubscribeSource(source uint8) SubscribeOption

type SubscribeOptions

+ Source uint8

Jul 18, 2022

Changes in this version

type Client

+ func (c *Client) HandleCommand(cmd *protocol.Command) bool

type SubscribeEvent

+ JoinLeave bool

type SubscribeOption

+ func WithEmitJoinLeave(enabled bool) SubscribeOption

+ func WithEmitPresence(enabled bool) SubscribeOption

+ func WithPositioning(enabled bool) SubscribeOption

+ func WithPushJoinLeave(enabled bool) SubscribeOption

+ func WithRecovery(enabled bool) SubscribeOption

type SubscribeOptions

+ EmitJoinLeave bool

+ EmitPresence bool

+ EnablePositioning bool

+ EnableRecovery bool

+ PushJoinLeave bool

Jun 28, 2022

Changes in this version

+ const UnsubscribeCodeClient

+ const UnsubscribeCodeDisconnect

+ const UnsubscribeCodeExpired

+ const UnsubscribeCodeInsufficient

+ const UnsubscribeCodeServer

+ var DisconnectConnectionClosed = Disconnect

type Client

+ func (c *Client) OnStateSnapshot(h StateSnapshotHandler)

+ func (c *Client) StateSnapshot() (interface{}, error)

type DisconnectOption

+ func WithCustomDisconnect(disconnect Disconnect) DisconnectOption

+ type EmulationConfig struct

+ MaxRequestBodySize int

+ type EmulationHandler struct

+ func NewEmulationHandler(node *Node, config EmulationConfig) *EmulationHandler

+ func (s *EmulationHandler) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type Error

+ Temporary bool

+ type HTTPStreamConfig struct

+ AppLevelPingInterval time.Duration

+ AppLevelPongTimeout time.Duration

+ MaxRequestBodySize int

+ type HTTPStreamHandler struct

+ func NewHTTPStreamHandler(node *Node, config HTTPStreamConfig) *HTTPStreamHandler

+ func (h *HTTPStreamHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Hub

+ func (h *Hub) Connections() map[string]*Client

+ type SSEConfig struct

+ AppLevelPingInterval time.Duration

+ AppLevelPongTimeout time.Duration

+ MaxRequestBodySize int

+ type SSEHandler struct

+ func NewSSEHandler(node *Node, config SSEConfig) *SSEHandler

+ func (h *SSEHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type StateSnapshotHandler func() (interface{}, error)

type SubscribeEvent

+ Positioned bool

+ Recoverable bool

type TransportInfo

+ Emulation func() bool

+ type Unsubscribe struct

+ Code uint32

+ Reason string

+ func (d Unsubscribe) String() string

type UnsubscribeOption

+ func WithCustomUnsubscribe(unsubscribe Unsubscribe) UnsubscribeOption

Feb 25, 2022

Changes in this version

type DisconnectOption

+ func WithDisconnectSession(sessionID string) DisconnectOption

type RefreshOption

+ func WithRefreshSession(sessionID string) RefreshOption

type SubscribeOption

+ func WithSubscribeSession(sessionID string) SubscribeOption

type UnsubscribeOption

+ func WithUnsubscribeSession(sessionID string) UnsubscribeOption

Feb 10, 2022

Changes in this version

+ var DisconnectNoPong = &Disconnect

+ type AppLevelPing struct

+ PingInterval time.Duration

+ PongTimeout time.Duration

type SockjsConfig

+ AppLevelPingInterval time.Duration

+ AppLevelPongTimeout time.Duration

type TransportInfo

+ AppLevelPing func() AppLevelPing

type WebsocketConfig

+ AppLevelPingInterval time.Duration

+ AppLevelPongTimeout time.Duration

+ PongTimeout time.Duration

Jan 26, 2022

Changes in this version

type LogLevel

+ const LogLevelWarn

+ type ProtocolVersion uint8

+ const ProtocolVersion1

+ const ProtocolVersion2

type Publication

+ Tags map[string]string

type PublishOption

+ func WithTags(meta map[string]string) PublishOption

type PublishOptions

+ Tags map[string]string

type RedisShardConfig

+ SentinelUser string

+ User string

type SockjsConfig

+ ProtocolVersion ProtocolVersion

type TransportInfo

+ ProtocolVersion func() ProtocolVersion

type WebsocketConfig

+ ProtocolVersion ProtocolVersion

Dec 2, 2021

Changes in this version

type SubscribeEvent

+ Data []byte

Nov 23, 2021

Changes in this version

type UnsubscribeEvent

+ Disconnect *Disconnect

+ Reason UnsubscribeReason

+ type UnsubscribeReason int

+ const UnsubscribeReasonClient

+ const UnsubscribeReasonDisconnect

+ const UnsubscribeReasonServer

Aug 23, 2021

Changes in this version

+ var DisconnectChannelLimit = &Disconnect

type Client

+ func (c *Client) Info() []byte

+ func (c *Client) Refresh(opts ...RefreshOption) error

type Config

+ UseSingleFlight bool

type ConnectEvent

+ Channels []string

type DisconnectOption

+ func WithDisconnectClient(clientID string) DisconnectOption

+ func WithDisconnectClientWhitelist(whitelist []string) DisconnectOption

type HistoryFilter

+ Reverse bool

type HistoryOption

+ func WithReverse(reverse bool) HistoryOption

type HistoryOptions

+ Reverse bool

type Hub

+ func (h *Hub) NumSubscriptions() int

+ func (h *Hub) UserConnections(userID string) map[string]*Client

type Node

+ func (n *Node) OnNodeInfoSend(handler NodeInfoSendHandler)

+ func (n *Node) OnTransportWrite(handler TransportWriteHandler)

+ func (n *Node) Refresh(userID string, opts ...RefreshOption) error

type NodeInfo

+ Data []byte

+ NumSubs uint32

+ type NodeInfoSendHandler func() NodeInfoSendReply

+ type NodeInfoSendReply struct

+ Data []byte

type RedisBrokerConfig

+ UseLists bool

+ type RefreshOption func(options *RefreshOptions)

+ func WithRefreshClient(clientID string) RefreshOption

+ func WithRefreshExpireAt(expireAt int64) RefreshOption

+ func WithRefreshExpired(expired bool) RefreshOption

+ func WithRefreshInfo(info []byte) RefreshOption

+ type RefreshOptions struct

+ ExpireAt int64

+ Expired bool

+ Info []byte

type SubscribeOption

+ func WithRecoverSince(since *StreamPosition) SubscribeOption

type SubscribeOptions

+ RecoverSince *StreamPosition

type Transport

+ WriteMany func(...[]byte) error

+ type TransportWriteEvent struct

+ Data []byte

+ IsPush bool

+ type TransportWriteHandler func(*Client, TransportWriteEvent) bool

Jun 23, 2021

Changes in this version

type Hub

+ func (h *Hub) BroadcastPublication(ch string, pub *Publication, sp StreamPosition) error

type MemoryBroker

+ func (b *MemoryBroker) Close(_ context.Context) error

type MemoryPresenceManager

+ func (m *MemoryPresenceManager) Close(_ context.Context) error

Apr 10, 2021

Changes in this version

type HistoryOption

+ func WithSince(sp *StreamPosition) HistoryOption

type Node

+ func (n *Node) Notify(op string, data []byte, toNodeID string) error

+ func (n *Node) OnNotification(handler NotificationHandler)

+ type NotificationEvent struct

+ Data []byte

+ FromNodeID string

+ Op string

+ type NotificationHandler func(NotificationEvent)

Mar 22, 2021

Changes in this version

+ const DefaultRedisBrokerPrefix

+ const DefaultRedisConnectTimeout

+ const DefaultRedisPresenceManagerPrefix

+ const DefaultRedisPresenceTTL

+ const DefaultRedisReadTimeout

+ const DefaultRedisWriteTimeout

+ const PushFlagConnect

+ const PushFlagDisconnect

+ const PushFlagJoin

+ const PushFlagLeave

+ const PushFlagMessage

+ const PushFlagPublication

+ const PushFlagSubscribe

+ const PushFlagUnsubscribe

type Client

+ func (c *Client) Connect(req ConnectRequest) error

+ type ConnectRequest struct

+ Data []byte

+ Name string

+ Subs map[string]SubscribeRequest

+ Token string

+ Version string

type LogLevel

+ const LogLevelTrace

+ type MemoryBroker struct

+ func NewMemoryBroker(n *Node, c MemoryBrokerConfig) (*MemoryBroker, error)

+ func (b *MemoryBroker) History(ch string, filter HistoryFilter) ([]*Publication, StreamPosition, error)

+ func (b *MemoryBroker) Publish(ch string, data []byte, opts PublishOptions) (StreamPosition, error)

+ func (b *MemoryBroker) PublishControl(data []byte, _, _ string) error

+ func (b *MemoryBroker) PublishJoin(ch string, info *ClientInfo) error

+ func (b *MemoryBroker) PublishLeave(ch string, info *ClientInfo) error

+ func (b *MemoryBroker) RemoveHistory(ch string) error

+ func (b *MemoryBroker) Run(h BrokerEventHandler) error

+ func (b *MemoryBroker) Subscribe(_ string) error

+ func (b *MemoryBroker) Unsubscribe(_ string) error

+ type MemoryBrokerConfig struct

+ HistoryMetaTTL time.Duration

+ type MemoryPresenceManager struct

+ func NewMemoryPresenceManager(n *Node, c MemoryPresenceManagerConfig) (*MemoryPresenceManager, error)

+ func (m *MemoryPresenceManager) AddPresence(ch string, uid string, info *ClientInfo) error

+ func (m *MemoryPresenceManager) Presence(ch string) (map[string]*ClientInfo, error)

+ func (m *MemoryPresenceManager) PresenceStats(ch string) (PresenceStats, error)

+ func (m *MemoryPresenceManager) RemovePresence(ch string, uid string) error

+ type MemoryPresenceManagerConfig struct

type Node

+ func (n *Node) Subscribe(userID string, channel string, opts ...SubscribeOption) error

+ type RedisBroker struct

+ func NewRedisBroker(n *Node, config RedisBrokerConfig) (*RedisBroker, error)

+ func (b *RedisBroker) History(ch string, filter HistoryFilter) ([]*Publication, StreamPosition, error)

+ func (b *RedisBroker) Publish(ch string, data []byte, opts PublishOptions) (StreamPosition, error)

+ func (b *RedisBroker) PublishControl(data []byte, nodeID, _ string) error

+ func (b *RedisBroker) PublishJoin(ch string, info *ClientInfo) error

+ func (b *RedisBroker) PublishLeave(ch string, info *ClientInfo) error

+ func (b *RedisBroker) RemoveHistory(ch string) error

+ func (b *RedisBroker) Run(h BrokerEventHandler) error

+ func (b *RedisBroker) Subscribe(ch string) error

+ func (b *RedisBroker) Unsubscribe(ch string) error

+ type RedisBrokerConfig struct

+ HistoryMetaTTL time.Duration

+ Prefix string

+ PubSubNumWorkers int

+ Shards []*RedisShard

+ UseStreams bool

+ type RedisPresenceManager struct

+ func NewRedisPresenceManager(n *Node, config RedisPresenceManagerConfig) (*RedisPresenceManager, error)

+ func (m *RedisPresenceManager) AddPresence(ch string, uid string, info *ClientInfo) error

+ func (m *RedisPresenceManager) Presence(ch string) (map[string]*ClientInfo, error)

+ func (m *RedisPresenceManager) PresenceStats(ch string) (PresenceStats, error)

+ func (m *RedisPresenceManager) RemovePresence(ch string, uid string) error

+ type RedisPresenceManagerConfig struct

+ Prefix string

+ PresenceTTL time.Duration

+ Shards []*RedisShard

+ type RedisShard struct

+ func NewRedisShard(n *Node, conf RedisShardConfig) (*RedisShard, error)

type RedisShardConfig

+ Address string

+ ClusterAddresses []string

+ SentinelAddresses []string

+ type SubscribeOption func(*SubscribeOptions)

+ func WithChannelInfo(chanInfo []byte) SubscribeOption

+ func WithExpireAt(expireAt int64) SubscribeOption

+ func WithJoinLeave(enabled bool) SubscribeOption

+ func WithPosition(enabled bool) SubscribeOption

+ func WithPresence(enabled bool) SubscribeOption

+ func WithRecover(enabled bool) SubscribeOption

+ func WithSubscribeClient(clientID string) SubscribeOption

+ func WithSubscribeData(data []byte) SubscribeOption

type SubscribeOptions

+ Data []byte

+ type SubscribeRequest struct

+ Epoch string

+ Offset uint64

+ Recover bool

type TransportInfo

+ DisabledPushFlags func() uint64

+ Unidirectional func() bool

type UnsubscribeEvent

+ ServerSide bool

type UnsubscribeOption

+ func WithUnsubscribeClient(clientID string) UnsubscribeOption

type WebsocketConfig

+ Unidirectional bool

Jan 25, 2021

Changes in this version

+ var ErrorUnrecoverablePosition = &Error

type Config

+ HistoryMaxPublicationLimit int

+ RecoveryMaxPublicationLimit int

type HistoryEvent

+ Filter HistoryFilter

type Node

+ func (n *Node) ID() string

+ func (n *Node) OnSurvey(handler SurveyHandler)

+ func (n *Node) Survey(ctx context.Context, op string, data []byte) (map[string]SurveyResult, error)

type SubscribeOptions

+ Position bool

+ type SurveyCallback func(SurveyReply)

+ type SurveyEvent struct

+ Data []byte

+ Op string

+ type SurveyHandler func(SurveyEvent, SurveyCallback)

+ type SurveyReply struct

+ Code uint32

+ Data []byte

+ type SurveyResult struct

+ Code uint32

+ Data []byte

Nov 4, 2020

Changes in this version

type DisconnectOption

+ func WithClientWhitelist(whitelist []string) DisconnectOption

+ func WithDisconnect(disconnect *Disconnect) DisconnectOption

type DisconnectOptions

+ ClientWhitelist []string

+ Disconnect *Disconnect

Oct 29, 2020

Changes in this version

+ const NoLimit

+ var DisconnectConnectionLimit = &Disconnect

type Client

+ func (c *Client) OnAlive(h AliveHandler)

+ func (c *Client) OnDisconnect(h DisconnectHandler)

+ func (c *Client) OnHistory(h HistoryHandler)

+ func (c *Client) OnMessage(h MessageHandler)

+ func (c *Client) OnPresence(h PresenceHandler)

+ func (c *Client) OnPresenceStats(h PresenceStatsHandler)

+ func (c *Client) OnPublish(h PublishHandler)

+ func (c *Client) OnRPC(h RPCHandler)

+ func (c *Client) OnRefresh(h RefreshHandler)

+ func (c *Client) OnSubRefresh(h SubRefreshHandler)

+ func (c *Client) OnSubscribe(h SubscribeHandler)

+ func (c *Client) OnUnsubscribe(h UnsubscribeHandler)

type Config

+ UserConnectionLimit int

+ type HistoryCallback func(HistoryReply, error)

type HistoryReply

+ Result *HistoryResult

+ type PresenceCallback func(PresenceReply, error)

type PresenceReply

+ Result *PresenceResult

+ type PresenceStatsCallback func(PresenceStatsReply, error)

type PresenceStatsReply

+ Result *PresenceStatsResult

+ type PublishCallback func(PublishReply, error)

type PublishEvent

+ ClientInfo *ClientInfo

type PublishOption

+ func WithClientInfo(info *ClientInfo) PublishOption

type PublishOptions

+ ClientInfo *ClientInfo

type PublishReply

+ Options PublishOptions

+ type RPCCallback func(RPCReply, error)

+ type RefreshCallback func(RefreshReply, error)

+ type SubRefreshCallback func(SubRefreshReply, error)

+ type SubscribeCallback func(SubscribeReply, error)

+ type SubscribeOptions struct

+ ChannelInfo []byte

+ ExpireAt int64

+ JoinLeave bool

+ Presence bool

+ Recover bool

type SubscribeReply

+ Options SubscribeOptions

Oct 1, 2020

Changes in this version

type Broker

+ History func(ch string, filter HistoryFilter) ([]*Publication, StreamPosition, error)

+ RemoveHistory func(ch string) error

type PublishOption

+ func WithHistory(size int, ttl time.Duration) PublishOption

type PublishOptions

+ HistorySize int

+ HistoryTTL time.Duration

Sep 19, 2020

Changes in this version

type Config

+ MetricsNamespace string

Aug 27, 2020

Changes in this version

+ var ErrorTooManyRequests = &Error

type Client

+ func (c *Client) IsSubscribed(ch string) bool

type ConnectEvent

+ Name string

+ Version string

Jul 10, 2020

Changes in this version

+ const EventAll

+ var ErrorUnknownChannel = &Error

+ type AliveHandler func(*Client)

+ type ChannelOptionsFunc func(channel string) (ChannelOptions, bool, error)

type Client

+ func (c *Client) Context() context.Context

+ func (c *Client) Disconnect(disconnect *Disconnect) error

+ type ClientCloseFunc func() error

type ClientInfo

+ ChanInfo []byte

+ ClientID string

+ ConnInfo []byte

+ UserID string

type Config

+ ChannelOptionsFunc ChannelOptionsFunc

type ConnectEvent

+ Transport TransportInfo

type ConnectReply

+ Events Event

type Disconnect

+ func (d *Disconnect) Error() string

+ type Event uint64

+ const EventAlive

+ const EventConnect

+ const EventDisconnect

+ const EventHistory

+ const EventMessage

+ const EventPresence

+ const EventPresenceStats

+ const EventPublish

+ const EventRPC

+ const EventRefresh

+ const EventSubRefresh

+ const EventSubscribe

+ const EventUnsubscribe

+ type HistoryEvent struct

+ Channel string

+ type HistoryHandler func(*Client, HistoryEvent) (HistoryReply, error)

+ type HistoryReply struct

type Node

+ func (n *Node) OnAlive(h AliveHandler)

+ func (n *Node) OnConnect(handler ConnectHandler)

+ func (n *Node) OnConnecting(handler ConnectingHandler)

+ func (n *Node) OnDisconnect(h DisconnectHandler)

+ func (n *Node) OnHistory(h HistoryHandler)

+ func (n *Node) OnMessage(h MessageHandler)

+ func (n *Node) OnPresence(h PresenceHandler)

+ func (n *Node) OnPresenceStats(h PresenceStatsHandler)

+ func (n *Node) OnPublish(h PublishHandler)

+ func (n *Node) OnRPC(h RPCHandler)

+ func (n *Node) OnRefresh(h RefreshHandler)

+ func (n *Node) OnSubRefresh(h SubRefreshHandler)

+ func (n *Node) OnSubscribe(h SubscribeHandler)

+ func (n *Node) OnUnsubscribe(h UnsubscribeHandler)

type PresenceEvent

+ Channel string

+ type PresenceResult struct

+ Presence map[string]*ClientInfo

+ type PresenceStatsEvent struct

+ Channel string

+ type PresenceStatsHandler func(*Client, PresenceStatsEvent) (PresenceStatsReply, error)

+ type PresenceStatsReply struct

+ type PresenceStatsResult struct

type Publication

+ Data []byte

+ Info *ClientInfo

+ Offset uint64

type PublishReply

+ Result *PublishResult

type RedisShardConfig

+ SentinelMasterName string

+ SentinelPassword string

type RefreshEvent

+ ClientSideRefresh bool

type SubRefreshEvent

+ ClientSideRefresh bool

+ Token string

type SubscribeEvent

+ Token string

type SubscribeReply

+ ClientSideRefresh bool

Jun 17, 2020

Changes in this version

type ClientEventHub

+ func (c *ClientEventHub) Presence(h PresenceHandler)

+ type CloseFunc func() error

type Config

+ ClientPresenceUpdateInterval time.Duration

type ConnectReply

+ ClientSideRefresh bool

+ type PresenceEvent struct

+ type PresenceHandler func(PresenceEvent) PresenceReply

+ type PresenceReply struct

type RefreshEvent

+ Token string

type RefreshReply

+ Disconnect *Disconnect

+ type TransportClient struct

+ func (c *TransportClient) Handle(data []byte) bool

+ func (c *TransportClient) ID() string

May 17, 2020

Changes in this version

type Disconnect

+ func (d *Disconnect) CloseText() string

+ func (d *Disconnect) String() string

May 9, 2020

Changes in this version

+ const UseSeqGen

+ var CompatibilityFlags uint64

+ type DisconnectOption func(options *DisconnectOptions)

+ func WithReconnect() DisconnectOption

+ type DisconnectOptions struct

+ Reconnect bool

type Error

+ Code uint32

+ Message string

+ func (e Error) Error() string

+ type HistoryOption func(options *HistoryOptions)

+ func Since(sp StreamPosition) HistoryOption

+ func WithLimit(limit int) HistoryOption

+ func WithNoLimit() HistoryOption

+ type HistoryOptions struct

+ Limit int

+ Since *StreamPosition

+ type HistoryResult struct

+ Publications []*Publication

type MemoryEngineConfig

+ HistoryMetaTTL time.Duration

+ type PublishResult struct

type RPCEvent

+ Method string

type RedisEngineConfig

+ HistoryMetaTTL time.Duration

+ UseStreams bool

type RedisShardConfig

+ ClusterAddrs []string

+ type StreamPosition struct

+ Epoch string

+ Offset uint64

Mar 7, 2020

Changes in this version

type Config

+ UserPersonalChannelNamespace string

+ UserSubscribeToPersonal bool

type SockjsConfig

+ WebsocketUseWriteBufferPool bool

Mar 4, 2020

Changes in this version

type ConnectReply

+ Channels []string

Feb 23, 2020

Changes in this version

type ChannelOptions

+ ServerSide bool

type Client

+ func (c *Client) Subscribe(channel string) error

type Config

+ UserPersonalChannelPrefix string

+ UserSubscribePersonal bool

type ConnectReply

+ Subscriptions []Subscription

type Credentials

+ func GetCredentials(ctx context.Context) (*Credentials, bool)

type Node

+ func (n *Node) PersonalChannel(user string) string

+ type Subscription struct

+ Channel string

+ type UnsubscribeOption func(*UnsubscribeOptions)

+ func WithResubscribe() UnsubscribeOption

+ type UnsubscribeOptions struct

+ Resubscribe bool

type WebsocketConfig

+ UseWriteBufferPool bool

Jan 3, 2020

Changes in this version

type Config

+ TokenHMACSecretKey string

+ TokenRSAPublicKey *rsa.PublicKey

Dec 15, 2019

Changes in this version

type RedisEngineConfig

+ SequenceTTL time.Duration

Oct 26, 2019

Changes in this version

type RefreshReply

+ Expired bool

Aug 25, 2019

Changes in this version

+ const DefaultWebsocketMessageSizeLimit

+ const DefaultWebsocketPingInterval

+ const DefaultWebsocketWriteTimeout

+ const EncodingTypeBinary

+ const EncodingTypeJSON

+ const ProtocolTypeJSON

+ const ProtocolTypeProtobuf

type Client

+ func NewClient(ctx context.Context, n *Node, t Transport, opts ...ClientOption) (*Client, error)

+ func (c *Client) Handle(data []byte) bool

+ type ClientOption func(*ClientOptions)

+ type ClientOptions struct

+ type EncodingType = proto.EncodingType

+ type ProtocolType = proto.ProtocolType

type SockjsConfig

+ CheckOrigin func(*http.Request) bool

+ WebsocketCheckOrigin func(*http.Request) bool

+ WebsocketWriteTimeout time.Duration

type Transport

+ Close func(*Disconnect) error

+ Write func([]byte) error

type TransportInfo

+ Encoding func() EncodingType

+ Meta func() TransportMeta

+ Name func() string

+ Protocol func() ProtocolType

+ type TransportMeta struct

+ Request *http.Request

type WebsocketConfig

+ MessageSizeLimit int

+ PingInterval time.Duration

+ WriteTimeout time.Duration

Jul 23, 2019

Changes in this version

type ChannelOptions

+ HistoryDisableForClient bool

+ PresenceDisableForClient bool

type PublishReply

+ Data Raw

May 18, 2019

Changes in this version

type NodeEventHub

+ ClientRefresh func(handler RefreshHandler)

Apr 9, 2019

Changes in this version

+ var DisconnectForceNoReconnect = &Disconnect

+ var DisconnectForceReconnect = &Disconnect

type Config

+ ClientChannelPositionCheckDelay time.Duration

+ LogHandler LogHandler

+ LogLevel LogLevel

type ConnectEvent

+ ClientID string

+ Token string

type ConnectReply

+ Context context.Context

+ Credentials *Credentials

+ type ConnectedHandler func(context.Context, *Client)

+ type ConnectingHandler func(context.Context, Transport, ConnectEvent) ConnectReply

type NodeEventHub

+ ClientConnected func(handler ConnectedHandler)

+ ClientConnecting func(handler ConnectingHandler)

Mar 13, 2019

Changes in this version

+ var DefaultConfig = Config

+ var DisconnectBadRequest = &Disconnect

+ var DisconnectExpired = &Disconnect

+ var DisconnectInsufficientState = &Disconnect

+ var DisconnectInvalidToken = &Disconnect

+ var DisconnectNormal = &Disconnect

+ var DisconnectServerError = &Disconnect

+ var DisconnectShutdown = &Disconnect

+ var DisconnectSlow = &Disconnect

+ var DisconnectStale = &Disconnect

+ var DisconnectSubExpired = &Disconnect

+ var DisconnectWriteError = &Disconnect

+ var ErrNoChannelOptions = errors.New("no channel options found")

+ var ErrPublished = errors.New("message published")

+ var ErrorAlreadySubscribed = &Error

+ var ErrorBadRequest = &Error

+ var ErrorExpired = &Error

+ var ErrorInternal = &Error

+ var ErrorLimitExceeded = &Error

+ var ErrorMethodNotFound = &Error

+ var ErrorNamespaceNotFound = &Error

+ var ErrorNotAvailable = &Error

+ var ErrorPermissionDenied = &Error

+ var ErrorTokenExpired = &Error

+ var ErrorUnauthorized = &Error

+ var LogStringToLevel = map[string]LogLevel

+ var PushTypeJoin = proto.PushTypeJoin

+ var PushTypeLeave = proto.PushTypeLeave

+ var PushTypePublication = proto.PushTypePublication

+ func LogLevelToString(l LogLevel) string

+ func SetCredentials(ctx context.Context, creds *Credentials) context.Context

+ type Broker interface

+ Channels func() ([]string, error)

+ Publish func(ch string, pub *Publication, opts *ChannelOptions) error

+ PublishControl func(data []byte) error

+ PublishJoin func(ch string, join *Join, opts *ChannelOptions) error

+ PublishLeave func(ch string, leave *Leave, opts *ChannelOptions) error

+ Run func(BrokerEventHandler) error

+ Subscribe func(ch string) error

+ Unsubscribe func(ch string) error

+ type BrokerEventHandler interface

+ HandleControl func([]byte) error

+ HandleJoin func(ch string, join *Join) error

+ HandleLeave func(ch string, leave *Leave) error

+ HandlePublication func(ch string, pub *Publication) error

+ type ChannelContext struct

+ Info proto.Raw

+ type ChannelNamespace struct

+ Name string

+ type ChannelOptions struct

+ Anonymous bool

+ HistoryLifetime int

+ HistoryRecover bool

+ HistorySize int

+ JoinLeave bool

+ Presence bool

+ Publish bool

+ SubscribeToPublish bool

+ type Client struct

+ func (c *Client) Channels() map[string]ChannelContext

+ func (c *Client) Close(disconnect *Disconnect) error

+ func (c *Client) ID() string

+ func (c *Client) On() *ClientEventHub

+ func (c *Client) Send(data Raw) error

+ func (c *Client) Transport() Transport

+ func (c *Client) Unsubscribe(ch string, resubscribe bool) error

+ func (c *Client) UserID() string

+ type ClientEventHub struct

+ func (c *ClientEventHub) Disconnect(h DisconnectHandler)

+ func (c *ClientEventHub) Message(h MessageHandler)

+ func (c *ClientEventHub) Publish(h PublishHandler)

+ func (c *ClientEventHub) RPC(h RPCHandler)

+ func (c *ClientEventHub) Refresh(h RefreshHandler)

+ func (c *ClientEventHub) SubRefresh(h SubRefreshHandler)

+ func (c *ClientEventHub) Subscribe(h SubscribeHandler)

+ func (c *ClientEventHub) Unsubscribe(h UnsubscribeHandler)

+ type ClientInfo = proto.ClientInfo

+ type Closer interface

+ Close func(ctx context.Context) error

+ type Config struct

+ ChannelMaxLength int

+ ChannelNamespaceBoundary string

+ ChannelPrivatePrefix string

+ ChannelUserBoundary string

+ ChannelUserSeparator string

+ ClientAnonymous bool

+ ClientChannelLimit int

+ ClientExpiredCloseDelay time.Duration

+ ClientExpiredSubCloseDelay time.Duration

+ ClientInsecure bool

+ ClientMessageWriteTimeout time.Duration

+ ClientPingInterval time.Duration

+ ClientPresenceExpireInterval time.Duration

+ ClientPresencePingInterval time.Duration

+ ClientQueueMaxSize int

+ ClientRequestMaxSize int

+ ClientStaleCloseDelay time.Duration

+ ClientUserConnectionLimit int

+ Name string

+ Namespaces []ChannelNamespace

+ NodeInfoMetricsAggregateInterval time.Duration

+ Secret string

+ Version string

+ func (c *Config) Validate() error

+ type ConnectEvent struct

+ Data Raw

+ type ConnectHandler func(context.Context, *Client, ConnectEvent) ConnectReply

+ type ConnectReply struct

+ Data Raw

+ Disconnect *Disconnect

+ Error *Error

+ type Credentials struct

+ ExpireAt int64

+ Info []byte

+ UserID string

+ type Disconnect struct

+ Code int

+ Reason string

+ Reconnect bool

+ type DisconnectEvent struct

+ Disconnect *Disconnect

+ type DisconnectHandler func(DisconnectEvent) DisconnectReply

+ type DisconnectReply struct

+ type Encoding = proto.Encoding

+ type Engine interface

+ type Error = proto.Error

+ type HistoryFilter struct

+ Limit int

+ Since *RecoveryPosition

+ type HistoryManager interface

+ AddHistory func(ch string, pub *Publication, opts *ChannelOptions) (*Publication, error)

+ History func(ch string, filter HistoryFilter) ([]*Publication, RecoveryPosition, error)

+ RemoveHistory func(ch string) error

+ type Hub struct

+ func (h *Hub) Channels() []string

+ func (h *Hub) NumChannels() int

+ func (h *Hub) NumClients() int

+ func (h *Hub) NumSubscribers(ch string) int

+ func (h *Hub) NumUsers() int

+ type Info struct

+ Nodes []NodeInfo

+ type Join = proto.Join

+ type Leave = proto.Leave

+ type LogEntry struct

+ Fields map[string]interface{}

+ Level LogLevel

+ Message string

+ func NewLogEntry(level LogLevel, message string, fields ...map[string]interface{}) LogEntry

+ type LogHandler func(LogEntry)

+ type LogLevel int

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelNone

+ type MemoryEngine struct

+ func NewMemoryEngine(n *Node, conf MemoryEngineConfig) (*MemoryEngine, error)

+ func (e *MemoryEngine) AddHistory(ch string, pub *Publication, opts *ChannelOptions) (*Publication, error)

+ func (e *MemoryEngine) AddPresence(ch string, uid string, info *ClientInfo, exp time.Duration) error

+ func (e *MemoryEngine) Channels() ([]string, error)

+ func (e *MemoryEngine) History(ch string, filter HistoryFilter) ([]*Publication, RecoveryPosition, error)

+ func (e *MemoryEngine) Presence(ch string) (map[string]*ClientInfo, error)

+ func (e *MemoryEngine) PresenceStats(ch string) (PresenceStats, error)

+ func (e *MemoryEngine) Publish(ch string, pub *Publication, opts *ChannelOptions) error

+ func (e *MemoryEngine) PublishControl(data []byte) error

+ func (e *MemoryEngine) PublishJoin(ch string, join *Join, opts *ChannelOptions) error

+ func (e *MemoryEngine) PublishLeave(ch string, leave *Leave, opts *ChannelOptions) error

+ func (e *MemoryEngine) RemoveHistory(ch string) error

+ func (e *MemoryEngine) RemovePresence(ch string, uid string) error

+ func (e *MemoryEngine) Run(h BrokerEventHandler) error

+ func (e *MemoryEngine) Subscribe(ch string) error

+ func (e *MemoryEngine) Unsubscribe(ch string) error

+ type MemoryEngineConfig struct

+ type MessageEvent struct

+ Data Raw

+ type MessageHandler func(MessageEvent) MessageReply

+ type MessageReply struct

+ Disconnect *Disconnect

+ type Metrics struct

+ Interval float64

+ Items map[string]float64

+ type Node struct

+ func New(c Config) (*Node, error)

+ func (n *Node) ChannelOpts(ch string) (ChannelOptions, bool)

+ func (n *Node) Channels() ([]string, error)

+ func (n *Node) Config() Config

+ func (n *Node) Disconnect(user string, reconnect bool) error

+ func (n *Node) History(ch string) ([]*Publication, error)

+ func (n *Node) Hub() *Hub

+ func (n *Node) Info() (Info, error)

+ func (n *Node) Log(entry LogEntry)

+ func (n *Node) LogEnabled(level LogLevel) bool

+ func (n *Node) NotifyShutdown() chan struct{}

+ func (n *Node) On() NodeEventHub

+ func (n *Node) Presence(ch string) (map[string]*ClientInfo, error)

+ func (n *Node) PresenceStats(ch string) (PresenceStats, error)

+ func (n *Node) Publish(ch string, data []byte, opts ...PublishOption) error

+ func (n *Node) Reload(c Config) error

+ func (n *Node) RemoveHistory(ch string) error

+ func (n *Node) Run() error

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

+ func (n *Node) SetEngine(e Engine)

+ func (n *Node) SetHistoryManager(m HistoryManager)

+ func (n *Node) SetLogHandler(level LogLevel, handler LogHandler)

+ func (n *Node) SetPresenceManager(m PresenceManager)

+ func (n *Node) Shutdown(ctx context.Context) error

+ func (n *Node) Unsubscribe(user string, ch string) error

+ type NodeEventHub interface

+ Connect func(handler ConnectHandler)

+ type NodeInfo struct

+ Metrics *Metrics

+ Name string

+ NumChannels uint32

+ NumClients uint32

+ NumUsers uint32

+ UID string

+ Uptime uint32

+ Version string

+ type PresenceManager interface

+ AddPresence func(ch string, clientID string, info *ClientInfo, expire time.Duration) error

+ Presence func(ch string) (map[string]*ClientInfo, error)

+ PresenceStats func(ch string) (PresenceStats, error)

+ RemovePresence func(ch string, clientID string) error

+ type PresenceStats struct

+ NumClients int

+ NumUsers int

+ type Publication = proto.Publication

+ type PublishEvent struct

+ Channel string

+ Data Raw

+ Info *ClientInfo

+ type PublishHandler func(PublishEvent) PublishReply

+ type PublishOption func(*PublishOptions)

+ func SkipHistory() PublishOption

+ type PublishOptions struct

+ SkipHistory bool

+ type PublishReply struct

+ Disconnect *Disconnect

+ Error *Error

+ type Push = proto.Push

+ type RPCEvent struct

+ Data Raw

+ type RPCHandler func(RPCEvent) RPCReply

+ type RPCReply struct

+ Data Raw

+ Disconnect *Disconnect

+ Error *Error

+ type Raw = proto.Raw

+ type RecoveryPosition struct

+ Epoch string

+ Gen uint32

+ Seq uint32

+ type RedisEngine struct

+ func NewRedisEngine(n *Node, config RedisEngineConfig) (*RedisEngine, error)

+ func (e *RedisEngine) AddHistory(ch string, pub *Publication, opts *ChannelOptions) (*Publication, error)

+ func (e *RedisEngine) AddPresence(ch string, uid string, info *ClientInfo, exp time.Duration) error

+ func (e *RedisEngine) Channels() ([]string, error)

+ func (e *RedisEngine) History(ch string, filter HistoryFilter) ([]*Publication, RecoveryPosition, error)

+ func (e *RedisEngine) Presence(ch string) (map[string]*ClientInfo, error)

+ func (e *RedisEngine) PresenceStats(ch string) (PresenceStats, error)

+ func (e *RedisEngine) Publish(ch string, pub *Publication, opts *ChannelOptions) error

+ func (e *RedisEngine) PublishControl(data []byte) error

+ func (e *RedisEngine) PublishJoin(ch string, join *Join, opts *ChannelOptions) error

+ func (e *RedisEngine) PublishLeave(ch string, leave *Leave, opts *ChannelOptions) error

+ func (e *RedisEngine) RemoveHistory(ch string) error

+ func (e *RedisEngine) RemovePresence(ch string, uid string) error

+ func (e *RedisEngine) Run(h BrokerEventHandler) error

+ func (e *RedisEngine) Subscribe(ch string) error

+ func (e *RedisEngine) Unsubscribe(ch string) error

+ type RedisEngineConfig struct

+ PublishOnHistoryAdd bool

+ Shards []RedisShardConfig

+ type RedisShardConfig struct

+ ConnectTimeout time.Duration

+ DB int

+ Host string

+ IdleTimeout time.Duration

+ MasterName string

+ Password string

+ Port int

+ Prefix string

+ PubSubNumWorkers int

+ ReadTimeout time.Duration

+ SentinelAddrs []string

+ TLSConfig *tls.Config

+ TLSSkipVerify bool

+ UseTLS bool

+ WriteTimeout time.Duration

+ type RefreshEvent struct

+ type RefreshHandler func(RefreshEvent) RefreshReply

+ type RefreshReply struct

+ ExpireAt int64

+ Info Raw

+ type SockjsConfig struct

+ HandlerPrefix string

+ HeartbeatDelay time.Duration

+ URL string

+ WebsocketReadBufferSize int

+ WebsocketWriteBufferSize int

+ type SockjsHandler struct

+ func NewSockjsHandler(n *Node, c SockjsConfig) *SockjsHandler

+ func (s *SockjsHandler) ServeHTTP(rw http.ResponseWriter, r *http.Request)

+ type SubRefreshEvent struct

+ Channel string

+ type SubRefreshHandler func(SubRefreshEvent) SubRefreshReply

+ type SubRefreshReply struct

+ ExpireAt int64

+ Expired bool

+ Info Raw

+ type SubscribeEvent struct

+ Channel string

+ type SubscribeHandler func(SubscribeEvent) SubscribeReply

+ type SubscribeReply struct

+ ChannelInfo Raw

+ Disconnect *Disconnect

+ Error *Error

+ ExpireAt int64

+ type Transport interface

+ Encoding func() Encoding

+ Info func() TransportInfo

+ Name func() string

+ type TransportInfo struct

+ Request *http.Request

+ type UnsubscribeEvent struct

+ Channel string

+ type UnsubscribeHandler func(UnsubscribeEvent) UnsubscribeReply

+ type UnsubscribeReply struct

+ type WebsocketConfig struct

+ CheckOrigin func(r *http.Request) bool

+ Compression bool

+ CompressionLevel int

+ CompressionMinSize int

+ ReadBufferSize int

+ WriteBufferSize int

+ type WebsocketHandler struct

+ func NewWebsocketHandler(n *Node, c WebsocketConfig) *WebsocketHandler

+ func (s *WebsocketHandler) ServeHTTP(rw http.ResponseWriter, r *http.Request)