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
- API
  
  Reference documentation for the pkg.go.dev API
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

ws

package module

Go to main page

Versions in this module

v0

v0.29.0

Jun 22, 2026

v0.28.0

May 20, 2026

v0.27.0

May 19, 2026

v0.26.0

May 18, 2026

v0.25.0

May 15, 2026

v0.24.0

May 15, 2026

v0.23.0

Apr 16, 2026

v0.22.0

Apr 16, 2026

v0.21.0

Apr 14, 2026

v0.20.0

Mar 27, 2026

Changes in this version

+ func BroadcastIn(space, msg string, values ...Map) error

+ func GroupcastIn(space, gid, msg string, values ...Map) error

+ func PushUserIn(space, uid, msg string, values ...Map) error

type AcceptOptions

+ Space string

type Command

+ Space string

type Context

+ Space string

type Delivery

+ func BroadcastResultIn(space, msg string, values ...Map) Delivery

+ func GroupcastResultIn(space, gid, msg string, values ...Map) Delivery

+ func PushUserResultIn(space, uid, msg string, values ...Map) Delivery

type Filter

+ Space string

type Handler

+ Space string

type Hook

+ Space string

type Message

+ Space string

type Session

+ Space string

+ func SessionsByUserIn(space, uid string) []*Session

v0.19.0

Mar 27, 2026

v0.18.0

Mar 27, 2026

Changes in this version

+ const BinaryMessage

+ const CloseMessage

+ const PingMessage

+ const PongMessage

+ const TextMessage

+ func Accept(opts AcceptOptions) error

+ func Broadcast(msg string, values ...Map) error

+ func CompressionEnabled() bool

+ func CompressionLevel() int

+ func Export() Map

+ func Groupcast(gid, msg string, values ...Map) error

+ func Push(sid, msg string, values ...Map) error

+ func PushUser(uid, msg string, values ...Map) error

+ type AcceptOptions struct

+ Args Map

+ Conn Conn

+ Domain string

+ Form Map

+ Host string

+ Locals Map

+ Meta *infra.Meta

+ Name string

+ Params Map

+ Path string

+ Query Map

+ RootDomain string

+ Setting Map

+ Site string

+ Uri string

+ Value Map

+ type Command struct

+ Args Vars

+ Desc string

+ Name string

+ Nullable bool

+ Setting Map

+ func (Command) RegistryComponent() string

+ type Commands map[string]Command

+ func (Commands) RegistryComponent() string

+ type Config struct

+ Codec string

+ CompressLevel int

+ Compression bool

+ Format string

+ MaxMessageSize int64

+ MessageKey string

+ ObserveInterval time.Duration

+ ObserveLog bool

+ ObserveTrace bool

+ PayloadKey string

+ PingInterval time.Duration

+ QueuePolicy string

+ QueueSize int

+ ReadTimeout time.Duration

+ Setting Map

+ WriteTimeout time.Duration

+ type Conn interface

+ Close func() error

+ Raw func() Any

+ ReadMessage func() (int, []byte, error)

+ WriteMessage func(messageType int, data []byte) error

+ type Context struct

+ Args Map

+ Command Command

+ Conn Conn

+ Input []byte

+ Locals Map

+ Message Message

+ Name string

+ Op string

+ Output []byte

+ Session *Session

+ Setting Map

+ Type int

+ Value Map

+ func (ctx *Context) Answer(msg string, data Map, results ...Res) error

+ func (ctx *Context) AnswerResult(msg string, data Map, results ...Res) Delivery

+ func (ctx *Context) BindUser(uid string)

+ func (ctx *Context) Broadcast(msg string, values ...Map) error

+ func (ctx *Context) BroadcastResult(msg string, values ...Map) Delivery

+ func (ctx *Context) Deny(args ...Res)

+ func (ctx *Context) Error(args ...Res)

+ func (ctx *Context) Fail(args ...Res)

+ func (ctx *Context) Groupcast(gid, msg string, values ...Map) error

+ func (ctx *Context) GroupcastResult(gid, msg string, values ...Map) Delivery

+ func (ctx *Context) Groups() []string

+ func (ctx *Context) InGroup(group string) bool

+ func (ctx *Context) Invalid(args ...Res)

+ func (ctx *Context) Join(groups ...string)

+ func (ctx *Context) Leave(groups ...string)

+ func (ctx *Context) LeaveAll()

+ func (ctx *Context) Next()

+ func (ctx *Context) Push(sid, msg string, values ...Map) error

+ func (ctx *Context) PushResult(sid, msg string, values ...Map) Delivery

+ func (ctx *Context) PushUser(uid, msg string, values ...Map) error

+ func (ctx *Context) PushUserResult(uid, msg string, values ...Map) Delivery

+ func (ctx *Context) Reply(msg string, values ...Map) error

+ func (ctx *Context) ReplyResult(msg string, values ...Map) Delivery

+ type Delivery struct

+ Failed int

+ FirstError string

+ Hit int

+ Success int

+ func BroadcastResult(msg string, values ...Map) Delivery

+ func GroupcastResult(gid, msg string, values ...Map) Delivery

+ func PushResult(sid, msg string, values ...Map) Delivery

+ func PushUserResult(uid, msg string, values ...Map) Delivery

+ type Filter struct

+ Desc string

+ Message ctxFunc

+ Name string

+ func (Filter) RegistryComponent() string

+ type Filters map[string]Filter

+ func (Filters) RegistryComponent() string

+ type Handler struct

+ Denied ctxFunc

+ Desc string

+ Error ctxFunc

+ Invalid ctxFunc

+ Name string

+ func (Handler) RegistryComponent() string

+ type Handlers map[string]Handler

+ func (Handlers) RegistryComponent() string

+ type Hook struct

+ Close ctxFunc

+ Desc string

+ Name string

+ Open ctxFunc

+ Receive ctxFunc

+ Send ctxFunc

+ func (Hook) RegistryComponent() string

+ type Hooks map[string]Hook

+ func (Hooks) RegistryComponent() string

+ type Message struct

+ Action ctxFunc

+ Args Vars

+ Desc string

+ Name string

+ Nullable bool

+ Setting Map

+ func (Message) RegistryComponent() string

+ type Messages map[string]Message

+ func (Messages) RegistryComponent() string

+ type Module struct

+ func (m *Module) Close()

+ func (m *Module) Config(global Map)

+ func (m *Module) Open()

+ func (m *Module) Register(name string, value Any)

+ func (m *Module) RegisterCommand(name string, command Command)

+ func (m *Module) RegisterCommands(prefix string, items Commands)

+ func (m *Module) RegisterFilter(name string, filter Filter)

+ func (m *Module) RegisterFilters(items Filters)

+ func (m *Module) RegisterHandler(name string, handler Handler)

+ func (m *Module) RegisterHandlers(items Handlers)

+ func (m *Module) RegisterHook(name string, hook Hook)

+ func (m *Module) RegisterHooks(items Hooks)

+ func (m *Module) RegisterMessage(name string, message Message)

+ func (m *Module) RegisterMessages(prefix string, items Messages)

+ func (m *Module) Setup()

+ func (m *Module) Start()

+ func (m *Module) Stop()

+ type Session struct

+ Args Map

+ Conn Conn

+ Domain string

+ Form Map

+ Groups map[string]Any

+ Host string

+ ID string

+ Locals Map

+ Meta *infra.Meta

+ Name string

+ Params Map

+ Path string

+ Query Map

+ RootDomain string

+ Setting Map

+ Site string

+ Uri string

+ User string

+ Value Map

+ func SessionByID(id string) *Session

+ func Sessions() []*Session

+ func SessionsByUser(uid string) []*Session

+ type Stats struct

+ AvgReceiveBytes int64

+ AvgSendBytes int64

+ BytesReceived int64

+ BytesSent int64

+ Connections int64

+ Dropped int64

+ MessagesReceived int64

+ MessagesSent int64

+ Queued int64

+ ReceiveFailed int64

+ SendFailed int64

+ Users int64

+ func Metrics() Stats