package connrotation

import "k8s.io/client-go/util/connrotation"

Package connrotation implements a connection dialer that tracks and can close all created connections.

This is used for credential rotation of long-lived connections, when there's no way to re-authenticate on a live connection.

Index ¶

• type ConnectionTracker
• func NewConnectionTracker() *ConnectionTracker
• func (c *ConnectionTracker) CloseAll()
• func (c *ConnectionTracker) Track(conn net.Conn) net.Conn
• type DialFunc
• type Dialer
• func NewDialer(dial DialFunc) *Dialer
• func NewDialerWithTracker(dial DialFunc, tracker *ConnectionTracker) *Dialer
• func (d *Dialer) Dial(network, address string) (net.Conn, error)
• func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)

Types ¶

type ConnectionTracker ¶

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

ConnectionTracker keeps track of opened connections

func NewConnectionTracker ¶

func NewConnectionTracker() *ConnectionTracker

NewConnectionTracker returns a connection tracker for use with NewDialerWithTracker

func (*ConnectionTracker) CloseAll ¶

func (c *ConnectionTracker) CloseAll()

CloseAll forcibly closes all tracked connections.

Note: new connections may get created before CloseAll returns.

func (*ConnectionTracker) Track ¶

func (c *ConnectionTracker) Track(conn net.Conn) net.Conn

Track adds the connection to the list of tracked connections, and returns a wrapped copy of the connection that stops tracking the connection when it is closed.

type DialFunc ¶

type DialFunc func(ctx context.Context, network, address string) (net.Conn, error)

DialFunc is a shorthand for signature of net.DialContext.

type Dialer ¶

type Dialer struct {
	*ConnectionTracker
	// contains filtered or unexported fields
}

Dialer opens connections through Dial and tracks them.

func NewDialer ¶

func NewDialer(dial DialFunc) *Dialer

NewDialer creates a new Dialer instance. Equivalent to NewDialerWithTracker(dial, nil).

func NewDialerWithTracker ¶

func NewDialerWithTracker(dial DialFunc, tracker *ConnectionTracker) *Dialer

NewDialerWithTracker creates a new Dialer instance.

If dial is not nil, it will be used to create new underlying connections. Otherwise net.DialContext is used. If tracker is not nil, it will be used to track new underlying connections. Otherwise NewConnectionTracker() is used.

func (*Dialer) Dial ¶

func (d *Dialer) Dial(network, address string) (net.Conn, error)

Dial creates a new tracked connection.

func (*Dialer) DialContext ¶

func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)

DialContext creates a new tracked connection.

Source Files ¶

connrotation.go