xproxy

Documentation

Overview

Package xproxy contains the implementation of the proxy service.

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

Index

• Variables
• func ErrorfFailedToResolveToEndpoint(ctx *context.T, format string, name string) error
• func ErrorfNotListening(ctx *context.T, format string) error
• func ErrorfProxyAlreadyClosed(ctx *context.T, format string) error
• func ErrorfProxyResponse(ctx *context.T, format string, msg string) error
• func ErrorfUnexpectedMessage(ctx *context.T, format string, msgType string) error
• func MessageFailedToResolveToEndpoint(ctx *context.T, message string, name string) error
• func MessageNotListening(ctx *context.T, message string) error
• func MessageProxyAlreadyClosed(ctx *context.T, message string) error
• func MessageProxyResponse(ctx *context.T, message string, msg string) error
• func MessageUnexpectedMessage(ctx *context.T, message string, msgType string) error
• func ParamsErrFailedToResolveToEndpoint(argumentError error) (verrorComponent string, verrorOperation string, name string, returnErr error)
• func ParamsErrNotListening(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)
• func ParamsErrProxyAlreadyClosed(argumentError error) (verrorComponent string, verrorOperation string, returnErr error)
• func ParamsErrProxyResponse(argumentError error) (verrorComponent string, verrorOperation string, msg string, returnErr error)
• func ParamsErrUnexpectedMessage(argumentError error) (verrorComponent string, verrorOperation string, msgType string, ...)
• type Proxy
  • func New(ctx *context.T, name string, auth security.Authorizer) (*Proxy, error)
  • func (p *Proxy) Closed() <-chan struct{}
  • func (p *Proxy) ListeningEndpoints() []naming.Endpoint

Variables

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 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.