Documentation

Overview

    nolint:golint

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	ErrListenerClosed     = verror.NewIDAction("v.io/x/ref/runtime/protocols/lib/websocket.ListenerClosed", verror.NoRetry)
    	ErrListenCalledInNaCl = verror.NewIDAction("v.io/x/ref/runtime/protocols/lib/websocket.ListenCalledInNaCl", verror.NoRetry)
    )

    Functions

    func ErrorfListenCalledInNaCl

    func ErrorfListenCalledInNaCl(ctx *context.T, format string) error

      ErrorfListenCalledInNaCl calls ErrListenCalledInNaCl.Errorf with the supplied arguments.

      func ErrorfListenerClosed

      func ErrorfListenerClosed(ctx *context.T, format string) error

        ErrorfListenerClosed calls ErrListenerClosed.Errorf with the supplied arguments.

        func MessageListenCalledInNaCl

        func MessageListenCalledInNaCl(ctx *context.T, message string) error

          MessageListenCalledInNaCl calls ErrListenCalledInNaCl.Message with the supplied arguments.

          func MessageListenerClosed

          func MessageListenerClosed(ctx *context.T, message string) error

            MessageListenerClosed calls ErrListenerClosed.Message with the supplied arguments.

            func NewErrListenCalledInNaCl

            func NewErrListenCalledInNaCl(ctx *context.T) error

              NewErrListenCalledInNaCl returns an error with the ErrListenCalledInNaCl ID. Deprecated: this function will be removed in the future, use ErrorfListenCalledInNaCl or MessageListenCalledInNaCl instead.

              func NewErrListenerClosed

              func NewErrListenerClosed(ctx *context.T) error

                NewErrListenerClosed returns an error with the ErrListenerClosed ID. Deprecated: this function will be removed in the future, use ErrorfListenerClosed or MessageListenerClosed instead.

                func ParamsErrListenCalledInNaCl

                func ParamsErrListenCalledInNaCl(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)

                  ParamsErrListenCalledInNaCl extracts the expected parameters from the error's ParameterList.

                  func ParamsErrListenerClosed

                  func ParamsErrListenerClosed(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)

                    ParamsErrListenerClosed extracts the expected parameters from the error's ParameterList.

                    func WebsocketConn

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

                      WebsocketConn provides a flow.Conn interface for a websocket connection. nolint:golint // API change required.

                      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.