proxy

Documentation

Overview

Package proxy provides a TCP reverse proxy. Unlike normal reverse proxy, the upstream is intentionally fixed. A new upstream will be selected if the current upstream is down.

Index

• Constants
• type Config
• type Proxy
  • func New(config Config) (*Proxy, error)
  • func (p *Proxy) Close()
  • func (p *Proxy) HasActiveUpstream() bool
  • func (p *Proxy) Port() int
  • func (p *Proxy) SetUpstreams(addresses []string)

Constants

const (
	DefaultUpstreamProbeInterval = 2 * time.Second
	DefaultDialTimeout           = 3 * time.Second
)

Types

type Config

type Config struct {
	KindTag               string
	UpstreamProbeInterval time.Duration
	DialTimeout           time.Duration
}

type Proxy

type Proxy struct {
	nocopy.NoCopy
	// contains filtered or unexported fields
}

func New

func New(config Config) (*Proxy, error)

func (*Proxy) Close

func (p *Proxy) Close()

Close stops any running loops and stops the listener. This function is concurrent-safe.

func (*Proxy) HasActiveUpstream

func (p *Proxy) HasActiveUpstream() bool

HasActiveUpstream returns whether there is an active upstream.

func (*Proxy) Port

func (p *Proxy) Port() int

Port returns the actual listening port.

func (*Proxy) SetUpstreams

func (p *Proxy) SetUpstreams(addresses []string)

SetUpstreams sets the upstream address list. This function is concurrent-safe.