proxy

Documentation

Overview

Package proxy is a transparent proxy built on the micro/server

Package proxy is a transparent proxy built on the micro/server

Index

• Variables
• type Option
  • func Tracer(t tracer.Tracer) Option
  • func WithClient(c client.Client) Option
  • func WithEndpoint(e string) Option
  • func WithLink(name string, c client.Client) Option
  • func WithLogger(l logger.Logger) Option
  • func WithMeter(m meter.Meter) Option
  • func WithRouter(r router.Router) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Proxy

Variables

var DefaultEndpoint = "localhost:9090"

DefaultEndpoint holds default proxy address

Types

type Option

type Option func(o *Options)

Option func signature

func Tracer

func Tracer(t tracer.Tracer) Option

Tracer to be used for tracing

func WithClient

func WithClient(c client.Client) Option

WithClient sets the client

func WithEndpoint

func WithEndpoint(e string) Option

WithEndpoint sets a proxy endpoint

func WithLink

func WithLink(name string, c client.Client) Option

WithLink sets a link for outbound requests

func WithLogger

func WithLogger(l logger.Logger) Option

WithLogger specifies the logger to use

func WithMeter

func WithMeter(m meter.Meter) Option

WithMeter specifies the meter to use

func WithRouter

func WithRouter(r router.Router) Option

WithRouter specifies the router to use

type Options

type Options struct {
	// Tracer used for tracing
	Tracer tracer.Tracer
	// Client for communication
	Client client.Client
	// Router for routing
	Router router.Router
	// Logger used for logging
	Logger logger.Logger
	// Meter used for metrics
	Meter meter.Meter
	// Links holds the communication links
	Links map[string]client.Client
	// Endpoint holds the destination address
	Endpoint string
}

Options for proxy

func NewOptions

func NewOptions(opts ...Option) Options

NewOptions returns new options struct that filled by opts

type Proxy

type Proxy interface {
	// ProcessMessage handles inbound messages
	ProcessMessage(context.Context, server.Message) error
	// ServeRequest handles inbound requests
	ServeRequest(context.Context, server.Request, server.Response) error
	// Name of the proxy protocol
	String() string
}

Proxy can be used as a proxy server for micro services