clientconn

Documentation

Overview

Package clientconn provides client connection implementation.

Index

• Variables
• type ConnMetrics
  • func (cm *ConnMetrics) Collect(ch chan<- prometheus.Metric)
  • func (cm *ConnMetrics) Describe(ch chan<- *prometheus.Desc)
• 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
• type ListenerMetrics
  • func (lm *ListenerMetrics) Collect(ch chan<- prometheus.Metric)
  • func (lm *ListenerMetrics) Describe(ch chan<- *prometheus.Desc)
• type Mode
• type NewListenerOpts

Variables

var AllModes = []Mode{NormalMode, ProxyMode, DiffNormalMode, DiffProxyMode}

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

Types

type ConnMetrics

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

ConnMetrics represents conn metrics.

func (*ConnMetrics) Collect

func (cm *ConnMetrics) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (*ConnMetrics) Describe

func (cm *ConnMetrics) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

type Listener

type Listener struct {
	// 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 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.

type ListenerMetrics

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

ListenerMetrics represents listener metrics.

func (*ListenerMetrics) Collect

func (lm *ListenerMetrics) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (*ListenerMetrics) Describe

func (lm *ListenerMetrics) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

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 {
	ListenAddr         string
	ProxyAddr          string
	Mode               Mode
	Handler            handlers.Interface
	Logger             *zap.Logger
	TestConnTimeout    time.Duration
	TestRunCancelDelay time.Duration
	TestRecordPath     string // if empty, no records are created
}

NewListenerOpts represents listener configuration.