websocket

Documentation

Index

• Variables
• func NewErrListenCalledInNaCl(ctx *context.T) error
• func NewErrListenerClosed(ctx *context.T) error
• func WebsocketConn(ws *websocket.Conn) flow.Conn
• type WS
  • func (WS) Dial(ctx *context.T, protocol, address string, timeout time.Duration) (flow.Conn, error)
  • func (WS) Listen(ctx *context.T, protocol, address string) (flow.Listener, error)
  • func (WS) Resolve(ctx *context.T, protocol, address string) (string, []string, error)
• type WSH
  • func (WSH) Dial(ctx *context.T, network, address string, timeout time.Duration) (flow.Conn, error)
  • func (WSH) Listen(ctx *context.T, protocol, address string) (flow.Listener, error)
  • func (WSH) Resolve(ctx *context.T, network, address string) (string, []string, error)

Variables

var (
	ErrListenerClosed     = verror.Register("v.io/x/ref/runtime/protocols/lib/websocket.ListenerClosed", verror.NoRetry, "{1:}{2:} listener is already closed.")
	ErrListenCalledInNaCl = verror.Register("v.io/x/ref/runtime/protocols/lib/websocket.ListenCalledInNaCl", verror.NoRetry, "{1:}{2:} Listen cannot be called in NaCl code.")
)

Functions

func NewErrListenCalledInNaCl

func NewErrListenCalledInNaCl(ctx *context.T) error

NewErrListenCalledInNaCl returns an error with the ErrListenCalledInNaCl ID.

func NewErrListenerClosed

func NewErrListenerClosed(ctx *context.T) error

NewErrListenerClosed returns an error with the ErrListenerClosed ID.

func WebsocketConn

func WebsocketConn(ws *websocket.Conn) flow.Conn

WebsocketConn provides a flow.Conn interface for a websocket connection.

Types

type WS

type WS struct{}

func (WS) Dial

func (WS) Dial(ctx *context.T, protocol, address string, timeout time.Duration) (flow.Conn, error)

func (WS) Listen

func (WS) Listen(ctx *context.T, protocol, address string) (flow.Listener, error)

func (WS) Resolve

func (WS) Resolve(ctx *context.T, protocol, address string) (string, []string, error)

type WSH

type WSH struct{}

func (WSH) Dial

func (WSH) Dial(ctx *context.T, network, address string, timeout time.Duration) (flow.Conn, error)

Dial returns flow.Conn that can be used with a HybridListener but always uses tcp. A client must specifically elect to use websockets by calling websocket.Dialer. The returned net.Conn will report 'tcp' as its Network.

func (WSH) Listen

func (WSH) Listen(ctx *context.T, protocol, address string) (flow.Listener, error)

Listener returns a flow.Conn that supports both tcp and websockets over the same, single, port. A listen address of --v23.tcp.protocol=wsh --v23.tcp.address=127.0.0.1:8101 means that port 8101 can accept connections that use either tcp or websocket. The listener looks at the first 4 bytes of the incoming data stream to decide if it's a websocket protocol or not. These must be 'GET ' for websockets, all other protocols must guarantee to not send 'GET ' as the first four bytes of the payload.

func (WSH) Resolve

func (WSH) Resolve(ctx *context.T, network, address string) (string, []string, error)

Resolve performs a DNS resolution on the network, address and always returns tcp as its Network.