Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

websockets

package module

Go to main page

Versions in this module

v1

v1.0.6

Mar 27, 2023

v1.0.3

Mar 24, 2023

v1.0.2

Mar 22, 2023

Changes in this version

+ var ErrRequestMessageIsTooLarge = fmt.Errorf("message is too large")

type Config

+ MaxRequestMessageSize string

+ ReadTimeout string

+ WriteTimeout string

type SubProtocolHandlerOptions

+ MaxRequestMessageSize int64

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

v1.0.1

Mar 21, 2023

v1.0.0

Mar 21, 2023

Changes in this version

+ const BinaryMessage

+ const CloseMessage

+ const PingMessage

+ const PongMessage

+ const TextMessage

+ func ConnectionId(ctx context.Context) (id string)

+ func Send(ctx context.Context, connectionId string, payload interface{}) (err error)

+ func Websocket(subs ...SubProtocolHandler) (handler service.HttpHandler)

+ type Config struct

+ EnableCompression bool

+ HandshakeTimeout string

+ MaxConnections int

+ ReadBufferSize string

+ WriteBufferSize string

+ type Connection interface

+ Close func() (err error)

+ CloseHandler func() func(code int, text string) error

+ EnableWriteCompression func(enable bool)

+ LocalAddr func() net.Addr

+ NextReader func() (messageType MessageType, r io.Reader, err error)

+ NextWriter func(messageType MessageType) (io.WriteCloser, error)

+ PingHandler func() func(appData string) error

+ PongHandler func() func(appData string) error

+ ReadMessage func() (messageType MessageType, p []byte, err error)

+ RemoteAddr func() net.Addr

+ SetCloseHandler func(h func(code int, text string) error)

+ SetCompressionLevel func(level int) error

+ SetPingHandler func(h func(appData string) error)

+ SetPongHandler func(h func(appData string) error)

+ SetReadDeadline func(t time.Time) error

+ SetReadLimit func(limit int64)

+ SetWriteDeadline func(t time.Time) error

+ Subprotocol func() (protocol string)

+ UnderlyingConn func() net.Conn

+ WriteControl func(messageType MessageType, data []byte, deadline time.Time) error

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

+ type MessageType int

+ type Request struct

+ Fn string

+ Header http.Header

+ Payload json.RawMessage

+ Service string

+ func (request *Request) DeviceId() (id string)

+ func (request *Request) DeviceIp() (id string)

+ func (request *Request) Validate() (err error)

+ type Response struct

+ Payload interface{}

+ Succeed bool

+ func Failed(err error) (resp *Response)

+ func Succeed(payload interface{}) (resp *Response)

+ func (resp *Response) Encode() (p []byte)

+ type Service struct

+ func (svc *Service) Build(options service.Options) (err error)

+ func (svc *Service) Components() (components map[string]service.Component)

+ func (svc *Service) Document() (doc service.Document)

+ func (svc *Service) Handle(ctx context.Context, fn string, argument service.Argument) (v interface{}, err errors.CodeError)

+ type SubProtocolHandler interface

+ Build func(options SubProtocolHandlerOptions) (err error)

+ Close func() (err error)

+ Handle func(conn Connection)

+ Name func() (name string)

+ Service func() (service service.Service)

+ type SubProtocolHandlerOptions struct

+ AppId string

+ AppName string

+ AppVersion versions.Version

+ Config configures.Config

+ Discovery service.EndpointDiscovery

+ Log logs.Logger

+ type SubProtocolHandlerTask struct

+ func (t *SubProtocolHandlerTask) Execute(_ context.Context)

+ type Task struct

+ func (t *Task) Execute(ctx context.Context)

+ type WebsocketConnection struct

+ func (conn *WebsocketConnection) NextReader() (messageType MessageType, r io.Reader, err error)

+ func (conn *WebsocketConnection) NextWriter(messageType MessageType) (w io.WriteCloser, err error)

+ func (conn *WebsocketConnection) ReadMessage() (messageType MessageType, p []byte, err error)

+ func (conn *WebsocketConnection) WriteControl(messageType MessageType, data []byte, deadline time.Time) error

+ func (conn *WebsocketConnection) WriteMessage(messageType MessageType, data []byte) (err error)