clientconn

Documentation

Overview

Package clientconn provides client connection implementation.

Index

• Variables
• type Listener
  • func NewListener(opts *NewListenerOpts) *Listener
  • func (l *Listener) Addr() net.Addr
  • func (l *Listener) Collect(ch chan<- prometheus.Metric)
  • func (l *Listener) Describe(ch chan<- *prometheus.Desc)
  • func (l *Listener) Run(ctx context.Context) error
  • func (l *Listener) TLS() net.Addr
  • func (l *Listener) Unix() net.Addr
• type ListenerOpts
• type Mode
• type NewListenerOpts

Variables

var AllModes = []string{
	string(NormalMode),
	string(ProxyMode),
	string(DiffNormalMode),
	string(DiffProxyMode),
}

AllModes includes all operation modes, with the first one being the default.

Types

type Listener

type Listener struct {
	*NewListenerOpts
	// contains filtered or unexported fields
}

Listener accepts incoming client connections.

func NewListener

func NewListener(opts *NewListenerOpts) *Listener

NewListener returns a new listener, configured by the NewListenerOpts argument.

func (*Listener) Addr

func (l *Listener) Addr() net.Addr

Addr returns TCP listener's address. It can be used to determine an actually used port, if it was zero.

func (*Listener) Collect

func (l *Listener) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (*Listener) Describe

func (l *Listener) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

func (*Listener) Run

func (l *Listener) Run(ctx context.Context) error

Run runs the listener until ctx is done or some unrecoverable error occurs.

When this method returns, listener and all connections are closed.

func (*Listener) TLS

func (l *Listener) TLS() net.Addr

TLS returns TLS listener address.

func (*Listener) Unix

func (l *Listener) Unix() net.Addr

Unix returns Unix domain socket address.

type ListenerOpts

type ListenerOpts struct {
	Addr        string
	Unix        string
	TLS         string
	TLSCertFile string
	TLSKeyFile  string
	TLSCAFile   string
}

ListenerOpts represents listener configuration options.

type Mode

type Mode string

Mode represents FerretDB mode of operation.

const (
	// NormalMode only handles requests.
	NormalMode Mode = "normal"
	// ProxyMode only proxies requests to another wire protocol compatible service.
	ProxyMode Mode = "proxy"
	// DiffNormalMode both handles requests and proxies them, then logs the diff.
	// Only the FerretDB response is sent to the client.
	DiffNormalMode Mode = "diff-normal"
	// DiffProxyMode both handles requests and proxies them, then logs the diff.
	// Only the proxy response is sent to the client.
	DiffProxyMode Mode = "diff-proxy"
)

type NewListenerOpts

type NewListenerOpts struct {
	Listener       ListenerOpts
	ProxyAddr      string
	Mode           Mode
	Metrics        *connmetrics.ListenerMetrics
	Handler        handlers.Interface
	Logger         *zap.Logger
	TestRecordsDir string // if empty, no records are created
}

NewListenerOpts represents listener configuration.