Documentation

Overview

    Package xproxy contains the implementation of the proxy service.

    Design document at https://docs.google.com/document/d/1ONrnxGhOrA8pd0pK0aN5Ued2Q1Eju4zn7vlLt9nzIRA/edit?usp=sharing

    nolint:golint

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	ErrNotListening              = verror.NewIDAction("v.io/x/ref/services/xproxy/xproxy.NotListening", verror.NoRetry)
    	ErrUnexpectedMessage         = verror.NewIDAction("v.io/x/ref/services/xproxy/xproxy.UnexpectedMessage", verror.NoRetry)
    	ErrFailedToResolveToEndpoint = verror.NewIDAction("v.io/x/ref/services/xproxy/xproxy.FailedToResolveToEndpoint", verror.NoRetry)
    	ErrProxyAlreadyClosed        = verror.NewIDAction("v.io/x/ref/services/xproxy/xproxy.ProxyAlreadyClosed", verror.NoRetry)
    	ErrProxyResponse             = verror.NewIDAction("v.io/x/ref/services/xproxy/xproxy.ProxyResponse", verror.NoRetry)
    )

    Functions

    func ErrorfFailedToResolveToEndpoint

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

      ErrorfFailedToResolveToEndpoint calls ErrFailedToResolveToEndpoint.Errorf with the supplied arguments.

      func ErrorfNotListening

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

        ErrorfNotListening calls ErrNotListening.Errorf with the supplied arguments.

        func ErrorfProxyAlreadyClosed

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

          ErrorfProxyAlreadyClosed calls ErrProxyAlreadyClosed.Errorf with the supplied arguments.

          func ErrorfProxyResponse

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

            ErrorfProxyResponse calls ErrProxyResponse.Errorf with the supplied arguments.

            func ErrorfUnexpectedMessage

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

              ErrorfUnexpectedMessage calls ErrUnexpectedMessage.Errorf with the supplied arguments.

              func MessageFailedToResolveToEndpoint

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

                MessageFailedToResolveToEndpoint calls ErrFailedToResolveToEndpoint.Message with the supplied arguments.

                func MessageNotListening

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

                  MessageNotListening calls ErrNotListening.Message with the supplied arguments.

                  func MessageProxyAlreadyClosed

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

                    MessageProxyAlreadyClosed calls ErrProxyAlreadyClosed.Message with the supplied arguments.

                    func MessageProxyResponse

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

                      MessageProxyResponse calls ErrProxyResponse.Message with the supplied arguments.

                      func MessageUnexpectedMessage

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

                        MessageUnexpectedMessage calls ErrUnexpectedMessage.Message with the supplied arguments.

                        func NewErrFailedToResolveToEndpoint

                        func NewErrFailedToResolveToEndpoint(ctx *context.T, name string) error

                          NewErrFailedToResolveToEndpoint returns an error with the ErrFailedToResolveToEndpoint ID. Deprecated: this function will be removed in the future, use ErrorfFailedToResolveToEndpoint or MessageFailedToResolveToEndpoint instead.

                          func NewErrNotListening

                          func NewErrNotListening(ctx *context.T) error

                            NewErrNotListening returns an error with the ErrNotListening ID. Deprecated: this function will be removed in the future, use ErrorfNotListening or MessageNotListening instead.

                            func NewErrProxyAlreadyClosed

                            func NewErrProxyAlreadyClosed(ctx *context.T) error

                              NewErrProxyAlreadyClosed returns an error with the ErrProxyAlreadyClosed ID. Deprecated: this function will be removed in the future, use ErrorfProxyAlreadyClosed or MessageProxyAlreadyClosed instead.

                              func NewErrProxyResponse

                              func NewErrProxyResponse(ctx *context.T, msg string) error

                                NewErrProxyResponse returns an error with the ErrProxyResponse ID. Deprecated: this function will be removed in the future, use ErrorfProxyResponse or MessageProxyResponse instead.

                                func NewErrUnexpectedMessage

                                func NewErrUnexpectedMessage(ctx *context.T, msgType string) error

                                  NewErrUnexpectedMessage returns an error with the ErrUnexpectedMessage ID. Deprecated: this function will be removed in the future, use ErrorfUnexpectedMessage or MessageUnexpectedMessage instead.

                                  func ParamsErrFailedToResolveToEndpoint

                                  func ParamsErrFailedToResolveToEndpoint(argumentError error) (verrorComponent string, verrorOperation string, name string, returnErr error)

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

                                    func ParamsErrNotListening

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

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

                                      func ParamsErrProxyAlreadyClosed

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

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

                                        func ParamsErrProxyResponse

                                        func ParamsErrProxyResponse(argumentError error) (verrorComponent string, verrorOperation string, msg string, returnErr error)

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

                                          func ParamsErrUnexpectedMessage

                                          func ParamsErrUnexpectedMessage(argumentError error) (verrorComponent string, verrorOperation string, msgType string, returnErr error)

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

                                            Types

                                            type Proxy

                                            type Proxy struct {
                                            	// contains filtered or unexported fields
                                            }

                                              Proxy represents an instance of a proxy service.

                                              func New

                                              func New(ctx *context.T, name string, auth security.Authorizer) (*Proxy, error)

                                                New returns a new instance of Proxy.

                                                func (*Proxy) Closed

                                                func (p *Proxy) Closed() <-chan struct{}

                                                  Closed returns a channel that will be closed when the proxy is shutdown.

                                                  func (*Proxy) ListeningEndpoints

                                                  func (p *Proxy) ListeningEndpoints() []naming.Endpoint

                                                    ListeningEndpoints returns the endpoints the proxy is listening on.