websocket

Documentation

Index

• Variables
• func New() transport.Factory
• func WithOptions(option *Options) transport.Option
• type Options
  • func FromContext(ctx context.Context, def *Options) *Options

Variables

var DefaultOptions = &Options{
	Dialer:   ws.DefaultDialer,
	Upgrader: ws.DefaultHTTPUpgrader,
	ServeMux: http.DefaultServeMux,
}

DefaultOptions default websocket options

Functions

func New

func New() transport.Factory

New websocket transport factory

func WithOptions

func WithOptions(option *Options) transport.Option

WithOptions to wrap the websocket options

Types

type Options

type Options struct {
	Cert     string          `json:"cert"`
	Key      string          `json:"key"`
	Binary   bool            `json:"binary,string"`
	Routers  []string        `json:"routers"`
	Dialer   ws.Dialer       `json:"-"`
	Upgrader ws.HTTPUpgrader `json:"-"`
	ServeMux *http.ServeMux  `json:"-"`
}

Options to define the websocket

func FromContext

func FromContext(ctx context.Context, def *Options) *Options

FromContext to unwrap the websocket options