Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

websocketspec

package

Go to main page

Versions in this module

v1

v1.0.4

Dec 31, 2025

v1.0.3

Dec 30, 2025

v1.0.2

Dec 30, 2025

v1.0.1

Dec 30, 2025

v1.0.0

Dec 30, 2025

v0

v0.0.122

Dec 30, 2025

Changes in this version

+ func ExampleAuthentication()

+ func ExampleCRUDOperations()

+ func ExampleWithBun(bunDB *bun.DB)

+ func ExampleWithGORM(db *gorm.DB)

+ func ExampleWithHooks(db *gorm.DB)

+ func ExampleWithSubscriptions()

+ type BroadcastMessage struct

+ Filter func(*Connection) bool

+ Message []byte

+ type Connection struct

+ ID string

+ func NewConnection(id string, ws *websocket.Conn, handler *Handler) *Connection

+ func (c *Connection) AddSubscription(sub *Subscription)

+ func (c *Connection) Close()

+ func (c *Connection) GetMetadata(key string) (interface{}, bool)

+ func (c *Connection) GetSubscription(subID string) (*Subscription, bool)

+ func (c *Connection) ReadPump()

+ func (c *Connection) RemoveSubscription(subID string)

+ func (c *Connection) Send(message []byte) error

+ func (c *Connection) SendJSON(v interface{}) error

+ func (c *Connection) SetMetadata(key string, value interface{})

+ func (c *Connection) WritePump()

+ type ConnectionManager struct

+ func NewConnectionManager(ctx context.Context) *ConnectionManager

+ func (cm *ConnectionManager) Broadcast(message []byte, filter func(*Connection) bool)

+ func (cm *ConnectionManager) Count() int

+ func (cm *ConnectionManager) GetConnection(id string) (*Connection, bool)

+ func (cm *ConnectionManager) Register(conn *Connection)

+ func (cm *ConnectionManager) Run()

+ func (cm *ConnectionManager) Shutdown()

+ func (cm *ConnectionManager) Unregister(conn *Connection)

+ type ErrorInfo struct

+ Code string

+ Details map[string]interface{}

+ Message string

+ type Handler struct

+ func NewHandler(db common.Database, registry common.ModelRegistry) *Handler

+ func NewHandlerWithBun(db *bun.DB) *Handler

+ func NewHandlerWithDatabase(db common.Database, registry common.ModelRegistry) *Handler

+ func NewHandlerWithGORM(db *gorm.DB) *Handler

+ func (h *Handler) BroadcastMessage(message interface{}, filter func(*Connection) bool) error

+ func (h *Handler) GetConnection(id string) (*Connection, bool)

+ func (h *Handler) GetConnectionCount() int

+ func (h *Handler) GetDatabase() common.Database

+ func (h *Handler) GetRelationshipInfo(modelType reflect.Type, relationName string) *common.RelationshipInfo

+ func (h *Handler) GetSubscriptionCount() int

+ func (h *Handler) HandleMessage(conn *Connection, msg *Message)

+ func (h *Handler) HandleWebSocket(w http.ResponseWriter, r *http.Request)

+ func (h *Handler) Hooks() *HookRegistry

+ func (h *Handler) Registry() common.ModelRegistry

+ func (h *Handler) Shutdown()

+ type HookContext struct

+ Connection *Connection

+ Context context.Context

+ Data interface{}

+ Entity string

+ Error error

+ Handler *Handler

+ ID string

+ Message *Message

+ Metadata map[string]interface{}

+ Model interface{}

+ ModelPtr interface{}

+ Options *common.RequestOptions

+ Result interface{}

+ Schema string

+ Subscription *Subscription

+ TableName string

+ type HookFunc func(*HookContext) error

+ type HookRegistry struct

+ func NewHookRegistry() *HookRegistry

+ func (hr *HookRegistry) Clear(hookType HookType)

+ func (hr *HookRegistry) ClearAll()

+ func (hr *HookRegistry) Execute(hookType HookType, ctx *HookContext) error

+ func (hr *HookRegistry) HasHooks(hookType HookType) bool

+ func (hr *HookRegistry) Register(hookType HookType, fn HookFunc)

+ func (hr *HookRegistry) RegisterAfter(operation OperationType, fn HookFunc)

+ func (hr *HookRegistry) RegisterBefore(operation OperationType, fn HookFunc)

+ type HookType string

+ const AfterConnect

+ const AfterCreate

+ const AfterDelete

+ const AfterDisconnect

+ const AfterRead

+ const AfterSubscribe

+ const AfterUnsubscribe

+ const AfterUpdate

+ const BeforeConnect

+ const BeforeCreate

+ const BeforeDelete

+ const BeforeDisconnect

+ const BeforeRead

+ const BeforeSubscribe

+ const BeforeUnsubscribe

+ const BeforeUpdate

+ type Message struct

+ Data interface{}

+ Entity string

+ Error *ErrorInfo

+ ID string

+ Metadata map[string]interface{}

+ Operation OperationType

+ Options *common.RequestOptions

+ RecordID string

+ Schema string

+ SubscriptionID string

+ Success bool

+ Timestamp time.Time

+ Type MessageType

+ func ParseMessage(data []byte) (*Message, error)

+ func (m *Message) IsValid() bool

+ func (m *Message) ToJSON() ([]byte, error)

+ type MessageType string

+ const MessageTypeError

+ const MessageTypeNotification

+ const MessageTypePing

+ const MessageTypePong

+ const MessageTypeRequest

+ const MessageTypeResponse

+ const MessageTypeSubscription

+ type NotificationMessage struct

+ Data interface{}

+ Entity string

+ Operation OperationType

+ Schema string

+ SubscriptionID string

+ Timestamp time.Time

+ Type MessageType

+ func NewNotificationMessage(subscriptionID string, operation OperationType, schema, entity string, ...) *NotificationMessage

+ func (n *NotificationMessage) ToJSON() ([]byte, error)

+ type OperationType string

+ const OperationCreate

+ const OperationDelete

+ const OperationMeta

+ const OperationRead

+ const OperationSubscribe

+ const OperationUnsubscribe

+ const OperationUpdate

+ type RequestMessage struct

+ Data interface{}

+ Entity string

+ ID string

+ Operation OperationType

+ Options *common.RequestOptions

+ RecordID string

+ Schema string

+ Type MessageType

+ func NewRequestMessage(id string, operation OperationType, schema, entity string) *RequestMessage

+ type ResponseMessage struct

+ Data interface{}

+ Error *ErrorInfo

+ ID string

+ Metadata map[string]interface{}

+ Success bool

+ Timestamp time.Time

+ Type MessageType

+ func NewErrorResponse(id string, code, message string) *ResponseMessage

+ func NewResponseMessage(id string, success bool, data interface{}) *ResponseMessage

+ func (r *ResponseMessage) ToJSON() ([]byte, error)

+ type Subscription struct

+ Active bool

+ ConnectionID string

+ Entity string

+ ID string

+ Options *common.RequestOptions

+ Schema string

+ func (s *Subscription) MatchesFilters(data interface{}) bool

+ type SubscriptionManager struct

+ func NewSubscriptionManager() *SubscriptionManager

+ func (sm *SubscriptionManager) Count() int

+ func (sm *SubscriptionManager) CountForEntity(schema, entity string) int

+ func (sm *SubscriptionManager) GetSubscription(subID string) (*Subscription, bool)

+ func (sm *SubscriptionManager) GetSubscriptionsByConnection(connID string) []*Subscription

+ func (sm *SubscriptionManager) GetSubscriptionsByEntity(schema, entity string) []*Subscription

+ func (sm *SubscriptionManager) Subscribe(id, connID, schema, entity string, options *common.RequestOptions) *Subscription

+ func (sm *SubscriptionManager) Unsubscribe(subID string) bool

+ type SubscriptionMessage struct

+ Entity string

+ ID string

+ Operation OperationType

+ Options *common.RequestOptions

+ Schema string

+ SubscriptionID string

+ Type MessageType