internal

package

Go to main page

Versions in this module

v1

v1.3.1

Mar 14, 2026

v1.3.0

Mar 12, 2026

Changes in this version

+ const ContentTypeBinary

+ const ContentTypeJSON

+ const ContentTypeMsgPack

+ const ContentTypeProtobuf

+ const ContentTypeText

+ const TransportSSE

+ const TransportWebSocket

type EnhancedConnection

+ GetContentType func() string

+ GetTransport func() string

+ SetContentType func(contentType string)

+ SetTransport func(transport string)

type Manager

+ Drain func(ctx context.Context) error

type Message

+ ContentType string

+ RawData []byte

v1.2.0

Mar 7, 2026

v1.0.0

Mar 1, 2026

v0

v0.10.0

Feb 24, 2026

Changes in this version

type Config

+ ConsistentHashReplicas int

+ EnableLoadBalancer bool

+ EnableSessionResumption bool

+ HealthCheckInterval time.Duration

+ HealthCheckTimeout time.Duration

+ LoadBalancerStrategy string

+ SessionResumptionTTL time.Duration

+ StickySessionTTL time.Duration

type ConfigOption

+ func WithLoadBalancer(strategy string) ConfigOption

+ func WithSessionResumption(ttl time.Duration) ConfigOption

type Manager

+ ResumeSession func(ctx context.Context, connID, sessionID string) (bool, error)

v0.9.12

Feb 18, 2026

v0.9.11

Feb 17, 2026

v0.9.10

Feb 16, 2026

v0.9.9

Feb 15, 2026

v0.9.7

Feb 11, 2026

v0.9.6

Feb 11, 2026

v0.9.5

Feb 10, 2026

v0.9.4

Feb 10, 2026

v0.9.3

Feb 10, 2026

v0.9.2

Feb 10, 2026

v0.9.1

Feb 8, 2026

v0.9.0

Feb 8, 2026

Changes in this version

+ const ActivityTypeCustom

+ const ActivityTypeListening

+ const ActivityTypePlaying

+ const ActivityTypeStreaming

+ const ActivityTypeWatching

+ const MessageTypeError

+ const MessageTypeJoin

+ const MessageTypeLeave

+ const MessageTypeMessage

+ const MessageTypePresence

+ const MessageTypeSystem

+ const MessageTypeTyping

+ const ModerationEventBan

+ const ModerationEventKick

+ const ModerationEventLock

+ const ModerationEventMute

+ const ModerationEventSlowMode

+ const ModerationEventUnban

+ const ModerationEventUnlock

+ const ModerationEventUnmute

+ const ModerationEventWarn

+ const NodeEventJoined

+ const NodeEventLeft

+ const NodeEventUpdated

+ const PatternExact

+ const PatternPrefix

+ const PatternSuffix

+ const PatternWildcard

+ const PermissionDeleteMessage

+ const PermissionInviteMembers

+ const PermissionManageRoles

+ const PermissionManageRoom

+ const PermissionRemoveMembers

+ const PermissionSendMessage

+ const RoleAdmin

+ const RoleGuest

+ const RoleMember

+ const RoleOwner

+ const RoomEventCreated

+ const RoomEventDeleted

+ const RoomEventMemberBanned

+ const RoomEventMemberJoined

+ const RoomEventMemberKicked

+ const RoomEventMemberLeft

+ const RoomEventUpdated

+ const StatusAway

+ const StatusBusy

+ const StatusOffline

+ const StatusOnline

+ const TypingEventStarted

+ const TypingEventStopped

+ var ErrAlreadyRoomMember = errors.New("already a member of the room")

+ var ErrAlreadySubscribed = errors.New("already subscribed to channel")

+ var ErrBackendNotConnected = errors.New("backend not connected")

+ var ErrBackendTimeout = errors.New("backend operation timeout")

+ var ErrBackendUnavailable = errors.New("backend unavailable")

+ var ErrChannelAlreadyExists = errors.New("channel already exists")

+ var ErrChannelNotFound = errors.New("channel not found")

+ var ErrConnectionClosed = errors.New("connection closed")

+ var ErrConnectionLimitReached = errors.New("connection limit reached")

+ var ErrConnectionNotFound = errors.New("connection not found")

+ var ErrInsufficientRole = errors.New("insufficient role")

+ var ErrInvalidChannel = errors.New("invalid channel")

+ var ErrInvalidConfig = errors.New("invalid configuration")

+ var ErrInvalidConnection = errors.New("invalid connection")

+ var ErrInvalidMessage = errors.New("invalid message")

+ var ErrInvalidPermission = errors.New("invalid permission")

+ var ErrInvalidRoom = errors.New("invalid room")

+ var ErrInvalidStatus = errors.New("invalid status")

+ var ErrInviteExpired = errors.New("invite expired")

+ var ErrInviteNotFound = errors.New("invite not found")

+ var ErrLockAcquisitionFailed = errors.New("failed to acquire lock")

+ var ErrLockNotHeld = errors.New("lock not held")

+ var ErrMessageNotFound = errors.New("message not found")

+ var ErrMessageTooLarge = errors.New("message too large")

+ var ErrMissingConfig = errors.New("missing required configuration")

+ var ErrNodeNotFound = errors.New("node not found")

+ var ErrNotRoomMember = errors.New("not a member of the room")

+ var ErrNotSubscribed = errors.New("not subscribed to channel")

+ var ErrPermissionDenied = errors.New("permission denied")

+ var ErrPresenceNotFound = errors.New("presence not found")

+ var ErrRoomAlreadyExists = errors.New("room already exists")

+ var ErrRoomFull = errors.New("room is full")

+ var ErrRoomLimitReached = errors.New("room limit reached")

+ var ErrRoomNotFound = errors.New("room not found")

+ func NewBackendError(backend, op string, err error) error

+ func NewChannelError(channelID, op string, err error) error

+ func NewConnectionError(connID, op string, err error) error

+ func NewMessageError(messageID, op string, err error) error

+ func NewRoomError(roomID, userID, op string, err error) error

+ type ActivityInfo struct

+ Assets map[string]any

+ Details string

+ EndTime *time.Time

+ Metadata map[string]any

+ Name string

+ StartTime time.Time

+ State string

+ Type string

+ type AnalyticsEvent struct

+ Data map[string]any

+ RoomID string

+ Timestamp time.Time

+ Type string

+ UserID string

+ type AnalyticsQuery struct

+ EndTime time.Time

+ Filters map[string]any

+ GroupBy string

+ Limit int

+ Metric string

+ StartTime time.Time

+ type AnalyticsResult struct

+ Labels map[string]string

+ Metadata map[string]any

+ Metric string

+ Timestamp time.Time

+ Value float64

+ type Availability struct

+ Available bool

+ Message string

+ UpdatedAt time.Time

+ type BackendError struct

+ Backend string

+ Err error

+ Op string

+ func (e *BackendError) Error() string

+ func (e *BackendError) Unwrap() error

+ type Channel interface

+ Delete func(ctx context.Context) error

+ GetCreated func() time.Time

+ GetID func() string

+ GetMessageCount func() int64

+ GetName func() string

+ GetSubscriberCount func(ctx context.Context) (int, error)

+ GetSubscribers func(ctx context.Context) ([]Subscription, error)

+ IsSubscribed func(ctx context.Context, connID string) (bool, error)

+ Publish func(ctx context.Context, message *Message) error

+ Subscribe func(ctx context.Context, sub Subscription) error

+ Unsubscribe func(ctx context.Context, connID string) error

+ type ChannelError struct

+ ChannelID string

+ Err error

+ Op string

+ func (e *ChannelError) Error() string

+ func (e *ChannelError) Unwrap() error

+ type ChannelOptions struct

+ Description string

+ ID string

+ Metadata map[string]any

+ Name string

+ Persistent bool

+ Private bool

+ type ChannelPattern interface

+ GetPattern func() string

+ Match func(channelName string) bool

+ type ChannelStore interface

+ AddSubscription func(ctx context.Context, channelID string, sub Subscription) error

+ Connect func(ctx context.Context) error

+ Create func(ctx context.Context, channel Channel) error

+ Delete func(ctx context.Context, channelID string) error

+ Disconnect func(ctx context.Context) error

+ Exists func(ctx context.Context, channelID string) (bool, error)

+ Get func(ctx context.Context, channelID string) (Channel, error)

+ GetSubscriberCount func(ctx context.Context, channelID string) (int, error)

+ GetSubscriptions func(ctx context.Context, channelID string) ([]Subscription, error)

+ GetUserChannels func(ctx context.Context, userID string) ([]Channel, error)

+ IsSubscribed func(ctx context.Context, channelID, connID string) (bool, error)

+ List func(ctx context.Context) ([]Channel, error)

+ Ping func(ctx context.Context) error

+ Publish func(ctx context.Context, channelID string, message *Message) error

+ RemoveSubscription func(ctx context.Context, channelID, connID string) error

+ type ClusterStats struct

+ ActiveNodes int

+ Extra map[string]any

+ MessagesPerSecond float64

+ Nodes []NodeInfo

+ TotalChannels int

+ TotalConnections int

+ TotalNodes int

+ TotalRooms int

+ Uptime time.Duration

+ type Config struct

+ Backend string

+ BackendPassword string

+ BackendURLs []string

+ BackendUsername string

+ EnableChannels bool

+ EnableDistributed bool

+ EnableMessageHistory bool

+ EnablePresence bool

+ EnableRooms bool

+ EnableTypingIndicators bool

+ HeartbeatInterval time.Duration

+ MaxChannelsPerUser int

+ MaxConnectionsPerUser int

+ MaxMessageSize int

+ MaxMessagesPerRoom int64

+ MaxMessagesPerSecond int

+ MaxRoomsPerUser int

+ MaxTypingUsersPerRoom int

+ MessageCleanup time.Duration

+ MessageRetention time.Duration

+ NodeID string

+ NodeTimeout time.Duration

+ PingInterval time.Duration

+ PongTimeout time.Duration

+ PresenceCleanup time.Duration

+ PresenceTimeout time.Duration

+ ReadBufferSize int

+ RequireConfig bool

+ TLSCAFile string

+ TLSCertFile string

+ TLSEnabled bool

+ TLSKeyFile string

+ TypingCleanup time.Duration

+ TypingTimeout time.Duration

+ WriteBufferSize int

+ WriteTimeout time.Duration

+ func DefaultConfig() Config

+ func (c *Config) Validate() error

+ type ConfigOption func(*Config)

+ func WithAuthentication(username, password string) ConfigOption

+ func WithBackend(backend string) ConfigOption

+ func WithBackendURLs(urls ...string) ConfigOption

+ func WithBufferSizes(read, write int) ConfigOption

+ func WithConfig(config Config) ConfigOption

+ func WithConnectionLimits(perUser, roomsPerUser, channelsPerUser int) ConfigOption

+ func WithFeatures(rooms, channels, presence, typing, history bool) ConfigOption

+ func WithLocalBackend() ConfigOption

+ func WithMessageLimits(maxSize, maxPerSecond int) ConfigOption

+ func WithMessageRetention(retention time.Duration) ConfigOption

+ func WithNATSBackend(urls ...string) ConfigOption

+ func WithNodeID(nodeID string) ConfigOption

+ func WithPresenceTimeout(timeout time.Duration) ConfigOption

+ func WithRedisBackend(url string) ConfigOption

+ func WithRequireConfig(require bool) ConfigOption

+ func WithTLS(certFile, keyFile, caFile string) ConfigOption

+ func WithTimeouts(ping, pong, write time.Duration) ConfigOption

+ func WithTypingTimeout(timeout time.Duration) ConfigOption

+ type ConnectionError struct

+ ConnID string

+ Err error

+ Op string

+ func (e *ConnectionError) Error() string

+ func (e *ConnectionError) Unwrap() error

+ type ConnectionInfo struct

+ ConnectedAt time.Time

+ ID string

+ IPAddress string

+ LastActivity time.Time

+ Metadata map[string]any

+ RoomsJoined []string

+ SessionID string

+ Subscriptions []string

+ UserAgent string

+ UserID string

+ type DeviceInfo struct

+ Active bool

+ Browser string

+ DeviceID string

+ IP string

+ LastSeen time.Time

+ Metadata map[string]any

+ OS string

+ Type string

+ type DistributedBackend interface

+ AcquireLock func(ctx context.Context, key string, ttl time.Duration) (Lock, error)

+ Connect func(ctx context.Context) error

+ Decrement func(ctx context.Context, key string) (int64, error)

+ Disconnect func(ctx context.Context) error

+ DiscoverNodes func(ctx context.Context) ([]NodeInfo, error)

+ GetCounter func(ctx context.Context, key string) (int64, error)

+ GetNode func(ctx context.Context, nodeID string) (*NodeInfo, error)

+ GetNodes func(ctx context.Context) ([]NodeInfo, error)

+ GetOnlineUsers func(ctx context.Context) ([]string, error)

+ GetPresence func(ctx context.Context, userID string) (*UserPresence, error)

+ Heartbeat func(ctx context.Context, nodeID string) error

+ Increment func(ctx context.Context, key string) (int64, error)

+ Ping func(ctx context.Context) error

+ Publish func(ctx context.Context, channel string, message *Message) error

+ RegisterNode func(ctx context.Context, nodeID string, metadata map[string]any) error

+ ReleaseLock func(ctx context.Context, lock Lock) error

+ SetPresence func(ctx context.Context, userID, status string, ttl time.Duration) error

+ Subscribe func(ctx context.Context, channel string, handler MessageHandler) error

+ UnregisterNode func(ctx context.Context, nodeID string) error

+ Unsubscribe func(ctx context.Context, channel string) error

+ WatchNodes func(ctx context.Context, handler NodeChangeHandler) error

+ type DistributedBackendOptions struct

+ HeartbeatInterval time.Duration

+ MaxReconnectAttempts int

+ NodeID string

+ NodeTimeout time.Duration

+ Options map[string]any

+ Password string

+ ReconnectBackoff time.Duration

+ TLSCAFile string

+ TLSCertFile string

+ TLSEnabled bool

+ TLSKeyFile string

+ Type string

+ URLs []string

+ Username string

+ func DefaultDistributedBackendOptions() DistributedBackendOptions

+ type EnhancedConnection interface

+ AddRoom func(roomID string)

+ AddSubscription func(channelID string)

+ GetJoinedRooms func() []string

+ GetLastActivity func() time.Time

+ GetMetadata func(key string) (any, bool)

+ GetSessionID func() string

+ GetSubscriptions func() []string

+ GetUserID func() string

+ IsClosed func() bool

+ IsInRoom func(roomID string) bool

+ IsSubscribed func(channelID string) bool

+ MarkClosed func()

+ RemoveRoom func(roomID string)

+ RemoveSubscription func(channelID string)

+ SetMetadata func(key string, value any)

+ SetSessionID func(sessionID string)

+ SetUserID func(userID string)

+ UpdateActivity func()

+ type FileInfo struct

+ ContentType string

+ ExpiresAt *time.Time

+ Filename string

+ ID string

+ Metadata map[string]any

+ RoomID string

+ Size int64

+ ThumbnailURL string

+ URL string

+ UploadedAt time.Time

+ UserID string

+ type FileQuery struct

+ After *time.Time

+ Before *time.Time

+ ContentType string

+ Filters map[string]any

+ Limit int

+ Offset int

+ RoomID string

+ UserID string

+ type FileUpload struct

+ ContentType string

+ Data []byte

+ Filename string

+ ID string

+ Metadata map[string]any

+ RoomID string

+ Size int64

+ URL string

+ UploadedAt time.Time

+ UserID string

+ type HistoryQuery struct

+ After time.Time

+ Before time.Time

+ Limit int

+ SearchTerm string

+ ThreadID string

+ UserID string

+ type Invite struct

+ Code string

+ CreatedAt time.Time

+ CreatedBy string

+ ExpiresAt *time.Time

+ MaxUses int

+ Metadata map[string]any

+ RoomID string

+ UsedCount int

+ type InviteOptions struct

+ Duration time.Duration

+ MaxUses int

+ Metadata map[string]any

+ Role string

+ type Lock interface

+ GetExpiry func() time.Time

+ GetKey func() string

+ GetOwner func() string

+ IsHeld func() bool

+ Renew func(ctx context.Context, ttl time.Duration) error

+ type Manager interface

+ AddReaction func(ctx context.Context, messageID, userID, emoji string) error

+ ArchiveRoom func(ctx context.Context, roomID string) error

+ BanUser func(ctx context.Context, userID, roomID string, reason string, until *time.Time) error

+ Broadcast func(ctx context.Context, message *Message) error

+ BroadcastExcept func(ctx context.Context, message *Message, excludeUserIDs []string) error

+ BroadcastToChannel func(ctx context.Context, channelID string, message *Message) error

+ BroadcastToRoom func(ctx context.Context, roomID string, message *Message) error

+ BroadcastToRooms func(ctx context.Context, roomIDs []string, message *Message) error

+ BroadcastToUsers func(ctx context.Context, userIDs []string, message *Message) error

+ BulkJoinRoom func(ctx context.Context, connIDs []string, roomID string) error

+ CheckRateLimit func(ctx context.Context, userID string, action string) (bool, error)

+ CleanupIdleConnections func(ctx context.Context, idleFor time.Duration) (int, error)

+ ClearTyping func(ctx context.Context, userID string) error

+ ConnectionCount func() int

+ CreateChannel func(ctx context.Context, channel Channel) error

+ CreateDirectMessage func(ctx context.Context, fromUserID, toUserID string) (string, error)

+ CreateRoom func(ctx context.Context, room Room) error

+ DeleteChannel func(ctx context.Context, channelID string) error

+ DeleteMessage func(ctx context.Context, messageID string) error

+ DeleteRoom func(ctx context.Context, roomID string) error

+ EditMessage func(ctx context.Context, messageID string, newContent any) error

+ GetActiveRooms func(ctx context.Context, since time.Duration) ([]Room, error)

+ GetAllConnections func() []EnhancedConnection

+ GetChannel func(ctx context.Context, channelID string) (Channel, error)

+ GetChannelSubscribers func(ctx context.Context, channelID string) ([]string, error)

+ GetConnection func(connID string) (EnhancedConnection, error)

+ GetConnectionInfo func(connID string) (*ConnectionInfo, error)

+ GetConnectionsByStatus func(status string) []EnhancedConnection

+ GetDirectMessages func(ctx context.Context, userID string) ([]Room, error)

+ GetHistory func(ctx context.Context, roomID string, query HistoryQuery) ([]*Message, error)

+ GetIdleConnections func(idleFor time.Duration) []EnhancedConnection

+ GetModerationLog func(ctx context.Context, roomID string, limit int) ([]ModerationEvent, error)

+ GetOnlineCount func(ctx context.Context) (int, error)

+ GetOnlineUsers func(ctx context.Context, roomID string) ([]string, error)

+ GetPresence func(ctx context.Context, userID string) (*UserPresence, error)

+ GetPresenceForUsers func(ctx context.Context, userIDs []string) ([]*UserPresence, error)

+ GetPresenceInRooms func(ctx context.Context, roomIDs []string) (map[string][]string, error)

+ GetPublicRooms func(ctx context.Context, limit int) ([]Room, error)

+ GetRateLimitStatus func(ctx context.Context, userID string) (*RateLimitStatus, error)

+ GetReactions func(ctx context.Context, messageID string) (map[string][]string, error)

+ GetRoom func(ctx context.Context, roomID string) (Room, error)

+ GetRoomMembers func(ctx context.Context, roomID string) ([]Member, error)

+ GetRoomStats func(ctx context.Context, roomID string) (*RoomStats, error)

+ GetStats func(ctx context.Context) (*ManagerStats, error)

+ GetThreadHistory func(ctx context.Context, roomID, threadID string, query HistoryQuery) ([]*Message, error)

+ GetTypingUsers func(ctx context.Context, roomID string) ([]string, error)

+ GetTypingUsersInChannels func(ctx context.Context, channelIDs []string) (map[string][]string, error)

+ GetUserChannels func(ctx context.Context, userID string) ([]Channel, error)

+ GetUserConnections func(userID string) []EnhancedConnection

+ GetUserMessages func(ctx context.Context, userID string, query HistoryQuery) ([]*Message, error)

+ GetUserRoomCount func(ctx context.Context, userID string) (int, error)

+ GetUserStats func(ctx context.Context, userID string) (*UserStats, error)

+ Health func(ctx context.Context) error

+ IsDirectMessage func(ctx context.Context, roomID string) (bool, error)

+ IsTyping func(ctx context.Context, userID, roomID string) (bool, error)

+ JoinRoom func(ctx context.Context, connID, roomID string) error

+ KickConnection func(ctx context.Context, connID string, reason string) error

+ LeaveRoom func(ctx context.Context, connID, roomID string) error

+ ListChannels func(ctx context.Context) ([]Channel, error)

+ ListRooms func(ctx context.Context) ([]Room, error)

+ MuteUser func(ctx context.Context, userID, roomID string, duration time.Duration) error

+ Register func(conn EnhancedConnection) error

+ RemoveReaction func(ctx context.Context, messageID, userID, emoji string) error

+ RestoreRoom func(ctx context.Context, roomID string) error

+ SaveMessage func(ctx context.Context, message *Message) error

+ SearchMessages func(ctx context.Context, roomID, searchTerm string, query HistoryQuery) ([]*Message, error)

+ SearchRooms func(ctx context.Context, query string, filters map[string]any) ([]Room, error)

+ SendToConnection func(ctx context.Context, connID string, message *Message) error

+ SendToUser func(ctx context.Context, userID string, message *Message) error

+ SetCustomStatus func(ctx context.Context, userID, customStatus string) error

+ SetPresence func(ctx context.Context, userID, status string) error

+ Start func(ctx context.Context) error

+ StartTyping func(ctx context.Context, userID, roomID string) error

+ Stop func(ctx context.Context) error

+ StopTyping func(ctx context.Context, userID, roomID string) error

+ Subscribe func(ctx context.Context, connID, channelID string, filters map[string]any) error

+ TrackActivity func(ctx context.Context, userID string) error

+ TransferRoomOwnership func(ctx context.Context, roomID, newOwnerID string) error

+ UnbanUser func(ctx context.Context, userID, roomID string) error

+ UnmuteUser func(ctx context.Context, userID, roomID string) error

+ Unregister func(connID string) error

+ Unsubscribe func(ctx context.Context, connID, channelID string) error

+ UpdateChannel func(ctx context.Context, channelID string, updates map[string]any) error

+ UpdateRoom func(ctx context.Context, roomID string, updates map[string]any) error

+ type ManagerStats struct

+ MemoryUsage int64

+ MessagesPerSec float64

+ OnlineUsers int

+ TotalChannels int

+ TotalConnections int

+ TotalMessages int64

+ TotalRooms int

+ Uptime time.Duration

+ type Member interface

+ GetJoinedAt func() time.Time

+ GetMetadata func() map[string]any

+ GetPermissions func() []string

+ GetRole func() string

+ GetUserID func() string

+ GrantPermission func(permission string)

+ HasPermission func(permission string) bool

+ RevokePermission func(permission string)

+ SetMetadata func(key string, value any)

+ SetRole func(role string)

+ type MemberOptions struct

+ Metadata map[string]any

+ Permissions []string

+ Role string

+ UserID string

+ type Message struct

+ ChannelID string

+ Data any

+ Event string

+ ID string

+ Metadata map[string]any

+ RoomID string

+ ThreadID string

+ Timestamp time.Time

+ Type string

+ UserID string

+ type MessageEdit struct

+ EditedAt time.Time

+ EditedBy string

+ MessageID string

+ NewContent any

+ PrevContent any

+ type MessageError struct

+ Err error

+ MessageID string

+ Op string

+ func (e *MessageError) Error() string

+ func (e *MessageError) Unwrap() error

+ type MessageFilter struct

+ EndTime time.Time

+ Metadata map[string]any

+ SearchTerm string

+ StartTime time.Time

+ ThreadID string

+ Types []string

+ UserIDs []string

+ type MessageHandler func(ctx context.Context, message *Message) error

+ type MessageReaction struct

+ Emoji string

+ MessageID string

+ Timestamp time.Time

+ UserID string

+ type MessageSearchQuery struct

+ After *time.Time

+ Before *time.Time

+ Filters map[string]any

+ Limit int

+ Offset int

+ Query string

+ RoomID string

+ UserID string

+ type MessageStats struct

+ AveragePerDay float64

+ CompressedSize int64

+ Extra map[string]any

+ MessagesByType map[string]int64

+ MessagesByUser map[string]int64

+ MessagesPerDay map[string]int64

+ NewestMessage time.Time

+ OldestMessage time.Time

+ StorageSize int64

+ TotalMessages int64

+ type MessageStore interface

+ Connect func(ctx context.Context) error

+ Delete func(ctx context.Context, messageID string) error

+ DeleteByRoom func(ctx context.Context, roomID string) error

+ DeleteByUser func(ctx context.Context, userID string) error

+ DeleteOld func(ctx context.Context, olderThan time.Duration) error

+ Disconnect func(ctx context.Context) error

+ Get func(ctx context.Context, messageID string) (*Message, error)

+ GetHistory func(ctx context.Context, roomID string, query HistoryQuery) ([]*Message, error)

+ GetMessageCount func(ctx context.Context, roomID string) (int64, error)

+ GetMessageCountByUser func(ctx context.Context, roomID, userID string) (int64, error)

+ GetThreadHistory func(ctx context.Context, roomID, threadID string, query HistoryQuery) ([]*Message, error)

+ GetUserMessages func(ctx context.Context, userID string, query HistoryQuery) ([]*Message, error)

+ Ping func(ctx context.Context) error

+ Save func(ctx context.Context, message *Message) error

+ SaveBatch func(ctx context.Context, messages []*Message) error

+ Search func(ctx context.Context, roomID, searchTerm string, query HistoryQuery) ([]*Message, error)

+ type MessageStoreOptions struct

+ CleanupInterval time.Duration

+ CompressAfter time.Duration

+ CompressOld bool

+ EnableSearch bool

+ Enabled bool

+ MaxMessagesPerRoom int64

+ RetentionPeriod time.Duration

+ func DefaultMessageStoreOptions() MessageStoreOptions

+ type ModerationEvent struct

+ ID string

+ Metadata map[string]any

+ ModeratorID string

+ Reason string

+ RoomID string

+ TargetID string

+ Timestamp time.Time

+ Type string

+ type ModerationStatus string

+ const ModerationStatusActive

+ const ModerationStatusApproved

+ const ModerationStatusExpired

+ const ModerationStatusPending

+ const ModerationStatusRejected

+ type NodeChangeEvent struct

+ Node NodeInfo

+ Timestamp time.Time

+ Type string

+ type NodeChangeHandler func(event NodeChangeEvent)

+ type NodeInfo struct

+ Address string

+ Channels int

+ Connections int

+ ID string

+ LastSeen time.Time

+ Metadata map[string]any

+ Rooms int

+ Started time.Time

+ Version string

+ type OnlineStats struct

+ Average24h float64

+ ByStatus map[string]int

+ ByTimezone map[string]int

+ Current int

+ Peak24h int

+ Trend string

+ type Pagination struct

+ Cursor string

+ Limit int

+ Offset int

+ type PresenceEvent struct

+ Metadata map[string]any

+ Status string

+ Timestamp time.Time

+ Type string

+ UserID string

+ type PresenceFilters struct

+ DeviceType string

+ Online bool

+ RoomID string

+ SinceActivity time.Time

+ Status []string

+ type PresenceOptions struct

+ AutoTrackActivity bool

+ BroadcastChanges bool

+ CleanupInterval time.Duration

+ OfflineTimeout time.Duration

+ func DefaultPresenceOptions() PresenceOptions

+ type PresenceStore interface

+ CleanupExpired func(ctx context.Context, olderThan time.Duration) error

+ Connect func(ctx context.Context) error

+ CountByStatus func(ctx context.Context) (map[string]int, error)

+ Delete func(ctx context.Context, userID string) error

+ DeleteMultiple func(ctx context.Context, userIDs []string) error

+ Disconnect func(ctx context.Context) error

+ Get func(ctx context.Context, userID string) (*UserPresence, error)

+ GetActiveCount func(ctx context.Context, since time.Duration) (int, error)

+ GetByStatus func(ctx context.Context, status string) ([]*UserPresence, error)

+ GetDevices func(ctx context.Context, userID string) ([]DeviceInfo, error)

+ GetHistory func(ctx context.Context, userID string, limit int) ([]*PresenceEvent, error)

+ GetHistorySince func(ctx context.Context, userID string, since time.Time) ([]*PresenceEvent, error)

+ GetLastActivity func(ctx context.Context, userID string) (time.Time, error)

+ GetMultiple func(ctx context.Context, userIDs []string) ([]*UserPresence, error)

+ GetOnline func(ctx context.Context) ([]string, error)

+ GetRecent func(ctx context.Context, status string, since time.Duration) ([]*UserPresence, error)

+ GetWithFilters func(ctx context.Context, filters PresenceFilters) ([]*UserPresence, error)

+ IsOnline func(ctx context.Context, userID string) (bool, error)

+ Ping func(ctx context.Context) error

+ RemoveDevice func(ctx context.Context, userID, deviceID string) error

+ SaveHistory func(ctx context.Context, userID string, event *PresenceEvent) error

+ Set func(ctx context.Context, userID string, presence *UserPresence) error

+ SetDevice func(ctx context.Context, userID, deviceID string, device DeviceInfo) error

+ SetMultiple func(ctx context.Context, presences map[string]*UserPresence) error

+ SetOffline func(ctx context.Context, userID string) error

+ SetOnline func(ctx context.Context, userID string, ttl time.Duration) error

+ UpdateActivity func(ctx context.Context, userID string, timestamp time.Time) error

+ type PresenceTracker interface

+ AddDevice func(ctx context.Context, userID, deviceID string, deviceInfo DeviceInfo) error

+ BroadcastPresence func(ctx context.Context, roomID, userID, status string) error

+ CleanupExpired func(ctx context.Context) error

+ GetActiveDevices func(ctx context.Context, userID string) ([]DeviceInfo, error)

+ GetActivity func(ctx context.Context, userID string) (*ActivityInfo, error)

+ GetAwayUsers func(ctx context.Context) ([]string, error)

+ GetBusyUsers func(ctx context.Context) ([]string, error)

+ GetCustomStatus func(ctx context.Context, userID string) (string, error)

+ GetDevices func(ctx context.Context, userID string) ([]DeviceInfo, error)

+ GetLastSeen func(ctx context.Context, userID string) (time.Time, error)

+ GetOnlineStats func(ctx context.Context) (*OnlineStats, error)

+ GetOnlineUsers func(ctx context.Context) ([]string, error)

+ GetOnlineUsersAt func(ctx context.Context, timestamp time.Time) ([]string, error)

+ GetOnlineUsersInRoom func(ctx context.Context, roomID string) ([]string, error)

+ GetPresence func(ctx context.Context, userID string) (*UserPresence, error)

+ GetPresenceBulk func(ctx context.Context, userIDs []string) (map[string]*UserPresence, error)

+ GetPresenceDuration func(ctx context.Context, userID string, status string, since time.Time) (time.Duration, error)

+ GetPresenceForRooms func(ctx context.Context, roomIDs []string) (map[string][]*UserPresence, error)

+ GetPresenceHistory func(ctx context.Context, userID string, since time.Time) ([]*PresenceEvent, error)

+ GetPresenceStats func(ctx context.Context, userID string) (*UserPresenceStats, error)

+ GetPresences func(ctx context.Context, userIDs []string) ([]*UserPresence, error)

+ GetRecentlyOffline func(ctx context.Context, since time.Duration) ([]string, error)

+ GetRecentlyOnline func(ctx context.Context, since time.Duration) ([]string, error)

+ GetRichPresence func(ctx context.Context, userID string) (map[string]any, error)

+ GetStatusChanges func(ctx context.Context, userID string, limit int) ([]*PresenceEvent, error)

+ GetUsersByStatus func(ctx context.Context, status string) ([]string, error)

+ GetWatchers func(ctx context.Context, userID string) ([]string, error)

+ GetWatching func(ctx context.Context, userID string) ([]string, error)

+ IsAvailable func(ctx context.Context, userID string) (bool, string, error)

+ IsOnline func(ctx context.Context, userID string) (bool, error)

+ RemoveDevice func(ctx context.Context, userID, deviceID string) error

+ SetActivity func(ctx context.Context, userID string, activity *ActivityInfo) error

+ SetAvailability func(ctx context.Context, userID string, available bool, message string) error

+ SetCustomStatus func(ctx context.Context, userID, customStatus string) error

+ SetPresence func(ctx context.Context, userID, status string) error

+ SetPresenceForUsers func(ctx context.Context, updates map[string]string) error

+ SetRichPresence func(ctx context.Context, userID string, richData map[string]any) error

+ Start func(ctx context.Context) error

+ Stop func(ctx context.Context) error

+ TrackActivity func(ctx context.Context, userID string) error

+ UnwatchUser func(ctx context.Context, watcherID, watchedUserID string) error

+ WatchUser func(ctx context.Context, watcherID, watchedUserID string) error

+ type RateLimitStatus struct

+ Allowed bool

+ Remaining int

+ ResetAt time.Time

+ RetryAfter time.Duration

+ type Room interface

+ AddTag func(ctx context.Context, tag string) error

+ Archive func(ctx context.Context) error

+ BanMember func(ctx context.Context, userID string, reason string, until *time.Time) error

+ Broadcast func(ctx context.Context, message *Message) error

+ BroadcastExcept func(ctx context.Context, message *Message, excludeUserIDs []string) error

+ BroadcastToRole func(ctx context.Context, message *Message, role string) error

+ CreateInvite func(ctx context.Context, opts InviteOptions) (*Invite, error)

+ Delete func(ctx context.Context) error

+ GetActiveMembers func(ctx context.Context, since time.Duration) ([]Member, error)

+ GetBannedMembers func(ctx context.Context) ([]RoomBan, error)

+ GetCategory func() string

+ GetCreated func() time.Time

+ GetDescription func() string

+ GetID func() string

+ GetInvites func(ctx context.Context) ([]*Invite, error)

+ GetLastReadMessage func(ctx context.Context, userID string) (string, error)

+ GetMaxMembers func() int

+ GetMember func(ctx context.Context, userID string) (Member, error)

+ GetMembers func(ctx context.Context) ([]Member, error)

+ GetMembersByRole func(ctx context.Context, role string) ([]Member, error)

+ GetMessageCount func(ctx context.Context) (int64, error)

+ GetMetadata func() map[string]any

+ GetModerationLog func(ctx context.Context, limit int) ([]ModerationEvent, error)

+ GetName func() string

+ GetOwner func() string

+ GetPinnedMessages func(ctx context.Context) ([]string, error)

+ GetSlowMode func(ctx context.Context) int

+ GetTags func() []string

+ GetUnreadCount func(ctx context.Context, userID string, since time.Time) (int, error)

+ GetUpdated func() time.Time

+ GrantPermission func(ctx context.Context, userID, permission string) error

+ HasPermission func(ctx context.Context, userID, permission string) (bool, error)

+ IsArchived func() bool

+ IsBanned func(ctx context.Context, userID string) (bool, error)

+ IsLocked func() bool

+ IsMember func(ctx context.Context, userID string) (bool, error)

+ IsMuted func(ctx context.Context, userID string) (bool, error)

+ IsPrivate func() bool

+ Join func(ctx context.Context, userID, role string) error

+ JoinWithInvite func(ctx context.Context, userID, inviteCode string) error

+ Leave func(ctx context.Context, userID string) error

+ Lock func(ctx context.Context, reason string) error

+ MarkAsRead func(ctx context.Context, userID, messageID string) error

+ MemberCount func(ctx context.Context) (int, error)

+ MuteMember func(ctx context.Context, userID string, duration time.Duration) error

+ PinMessage func(ctx context.Context, messageID string) error

+ RemoveTag func(ctx context.Context, tag string) error

+ RevokeInvite func(ctx context.Context, inviteCode string) error

+ RevokePermission func(ctx context.Context, userID, permission string) error

+ SetCategory func(ctx context.Context, category string) error

+ SetMaxMembers func(ctx context.Context, max int) error

+ SetPrivate func(ctx context.Context, private bool) error

+ SetSlowMode func(ctx context.Context, intervalSeconds int) error

+ TransferOwnership func(ctx context.Context, newOwnerID string) error

+ Unarchive func(ctx context.Context) error

+ UnbanMember func(ctx context.Context, userID string) error

+ Unlock func(ctx context.Context) error

+ UnmuteMember func(ctx context.Context, userID string) error

+ UnpinMessage func(ctx context.Context, messageID string) error

+ Update func(ctx context.Context, updates map[string]any) error

+ UpdateMemberRole func(ctx context.Context, userID, newRole string) error

+ ValidateInvite func(ctx context.Context, inviteCode string) (bool, error)

+ type RoomBan struct

+ BannedAt time.Time

+ BannedBy string

+ ExpiresAt *time.Time

+ Metadata map[string]any

+ Reason string

+ RoomID string

+ UserID string

+ type RoomError struct

+ Err error

+ Op string

+ RoomID string

+ UserID string

+ func (e *RoomError) Error() string

+ func (e *RoomError) Unwrap() error

+ type RoomEvent struct

+ Data map[string]any

+ RoomID string

+ Timestamp time.Time

+ Type string

+ UserID string

+ type RoomOptions struct

+ Description string

+ ID string

+ MaxMembers int

+ Metadata map[string]any

+ Name string

+ Owner string

+ Private bool

+ type RoomStats struct

+ ActiveMembers int

+ AverageMessages float64

+ CreatedAt time.Time

+ LastActivity time.Time

+ MessagesToday int64

+ PeakOnline int

+ TotalMembers int

+ TotalMessages int64

+ type RoomStore interface

+ AddMember func(ctx context.Context, roomID string, member Member) error

+ BanMember func(ctx context.Context, roomID, userID string, ban RoomBan) error

+ Connect func(ctx context.Context) error

+ Create func(ctx context.Context, room Room) error

+ CreateMany func(ctx context.Context, rooms []Room) error

+ Delete func(ctx context.Context, roomID string) error

+ DeleteInvite func(ctx context.Context, inviteCode string) error

+ DeleteMany func(ctx context.Context, roomIDs []string) error

+ Disconnect func(ctx context.Context) error

+ Exists func(ctx context.Context, roomID string) (bool, error)

+ FindByCategory func(ctx context.Context, category string) ([]Room, error)

+ FindByTag func(ctx context.Context, tag string) ([]Room, error)

+ Get func(ctx context.Context, roomID string) (Room, error)

+ GetArchivedRooms func(ctx context.Context, userID string) ([]Room, error)

+ GetBans func(ctx context.Context, roomID string) ([]RoomBan, error)

+ GetCommonRooms func(ctx context.Context, userID1, userID2 string) ([]Room, error)

+ GetInvite func(ctx context.Context, inviteCode string) (*Invite, error)

+ GetMember func(ctx context.Context, roomID, userID string) (Member, error)

+ GetMembers func(ctx context.Context, roomID string) ([]Member, error)

+ GetPublicRooms func(ctx context.Context, limit int) ([]Room, error)

+ GetRoomCount func(ctx context.Context) (int, error)

+ GetTotalMembers func(ctx context.Context) (int, error)

+ GetUserRooms func(ctx context.Context, userID string) ([]Room, error)

+ GetUserRoomsByRole func(ctx context.Context, userID, role string) ([]Room, error)

+ IsBanned func(ctx context.Context, roomID, userID string) (bool, error)

+ IsMember func(ctx context.Context, roomID, userID string) (bool, error)

+ List func(ctx context.Context, filters map[string]any) ([]Room, error)

+ ListInvites func(ctx context.Context, roomID string) ([]*Invite, error)

+ MemberCount func(ctx context.Context, roomID string) (int, error)

+ Ping func(ctx context.Context) error

+ RemoveMember func(ctx context.Context, roomID, userID string) error

+ SaveInvite func(ctx context.Context, roomID string, invite *Invite) error

+ Search func(ctx context.Context, query string, filters map[string]any) ([]Room, error)

+ UnbanMember func(ctx context.Context, roomID, userID string) error

+ Update func(ctx context.Context, roomID string, updates map[string]any) error

+ type Subscription interface

+ GetConnID func() string

+ GetFilters func() map[string]any

+ GetSubscribedAt func() time.Time

+ GetUserID func() string

+ MatchesFilter func(message *Message) bool

+ SetFilters func(filters map[string]any)

+ type SubscriptionOptions struct

+ ConnID string

+ Filters map[string]any

+ UserID string

+ type TypingEvent struct

+ RoomID string

+ Timestamp time.Time

+ Type string

+ UserID string

+ type TypingOptions struct

+ BroadcastEvents bool

+ CleanupInterval time.Duration

+ MaxTypingUsers int

+ TypingTimeout time.Duration

+ func DefaultTypingOptions() TypingOptions

+ type TypingStore interface

+ CleanupExpired func(ctx context.Context) error

+ Connect func(ctx context.Context) error

+ Disconnect func(ctx context.Context) error

+ GetTypingUsers func(ctx context.Context, roomID string) ([]string, error)

+ IsTyping func(ctx context.Context, userID, roomID string) (bool, error)

+ Ping func(ctx context.Context) error

+ RemoveTyping func(ctx context.Context, userID, roomID string) error

+ SetTyping func(ctx context.Context, userID, roomID string, expiresAt time.Time) error

+ type TypingTracker interface

+ BroadcastTyping func(ctx context.Context, roomID, userID string, isTyping bool) error

+ CleanupExpired func(ctx context.Context) error

+ GetTypingUsers func(ctx context.Context, roomID string) ([]string, error)

+ IsTyping func(ctx context.Context, userID, roomID string) (bool, error)

+ Start func(ctx context.Context) error

+ StartTyping func(ctx context.Context, userID, roomID string) error

+ Stop func(ctx context.Context) error

+ StopTyping func(ctx context.Context, userID, roomID string) error

+ type UserPresence struct

+ Connections []string

+ CustomStatus string

+ LastSeen time.Time

+ Metadata map[string]any

+ Status string

+ UserID string

+ type UserPresenceStats struct

+ AverageOnlineTime time.Duration

+ DeviceCount int

+ LastOnline time.Time

+ Metadata map[string]any

+ MostCommonStatus string

+ StatusChanges int

+ TotalOnlineTime time.Duration

+ type UserStats struct

+ AverageActivity float64

+ LastSeen time.Time

+ MessagesSent int64

+ OnlineTime time.Duration

+ RoomsJoined int

+ type WebhookConfig struct

+ Active bool

+ CreatedAt time.Time

+ Events []string

+ Headers map[string]string

+ ID string

+ RetryCount int

+ Secret string

+ Timeout time.Duration

+ URL string

+ UpdatedAt time.Time

Other modules containing this package

github.com/xraph/forge

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