ws

Documentation

Index

• Variables
• type CheckOriginFunc
• type Listener
  • func (l *Listener) Accept(opts options.Options) (transport.Connection, error)
  • func (l *Listener) Close() error
  • func (l *Listener) Listen(opts options.Options) (err error)
  • func (l *Listener) ServeHTTP(resp http.ResponseWriter, req *http.Request)

Variables

var (
	// OptionDomains is option's domain
	OptionDomains = append(transport.OptionDomains, "ws")
	// Options for websocket
	Options = wsOptions{
		ReadBufferSize:  options.NewIntOption(4 * 1024),
		WriteBufferSize: options.NewIntOption(4 * 1024),
		Listener: listenerOptions{
			CheckOrigin:    options.NewBoolOption(false),
			OriginChecker:  options.NewAnyOption(noCheckOrigin),
			ExternalListen: options.NewBoolOption(false),
			PendingSize:    options.NewIntOption(16),
		},
	}
)

var (
	// RwTransport is a transport.Transport for Websocket, using ReadWriter.
	RwTransport = &wsTran{scheme: "ws.rw", isRw: true}
	// SrTransport is a transport.Transport for Websocket, using SendReceiver+ReadWriter.
	SrTransport = &wsTran{scheme: "ws.sr", isSr: true}
)

Types

type CheckOriginFunc

type CheckOriginFunc func(r *http.Request) bool

CheckOriginFunc check request origin

type Listener

type Listener struct {
	URL *url.URL

	*http.ServeMux

	sync.Mutex
	// contains filtered or unexported fields
}

Listener websocket listener, exported for add handler or self serving

func (*Listener) Accept

func (l *Listener) Accept(opts options.Options) (transport.Connection, error)

Accept start accept

func (*Listener) Close

func (l *Listener) Close() error

Close stop listen

func (*Listener) Listen

func (l *Listener) Listen(opts options.Options) (err error)

Listen start listen

func (*Listener) ServeHTTP

func (l *Listener) ServeHTTP(resp http.ResponseWriter, req *http.Request)