connection

Documentation

Overview

Package connection manages (abstract) connections with retrying and reconnection.

Index

• func UsingConnection[T any](ctx context.Context, r *Reconnector, desc string, ...) (T, error)
• type Connection
• type ConnectorImpl
• type Reconnector
  • func NewReconnector(conn ConnectorImpl) *Reconnector
  • func (r *Reconnector) CloseActiveConnection(ctx context.Context)
  • func (r *Reconnector) GetOrOpenConnection(ctx context.Context) (Connection, error)
  • func (r *Reconnector) UsingConnectionNoResult(ctx context.Context, desc string, cb func(cli Connection) error) error

Functions

func UsingConnection

func UsingConnection[T any](ctx context.Context, r *Reconnector, desc string, cb func(cli Connection) (T, error)) (T, error)

UsingConnection invokes the provided callback for a Connection.

Types

type Connection

type Connection interface {
	fmt.Stringer
	io.Closer
}

Connection encapsulates a single connection.

type ConnectorImpl

type ConnectorImpl interface {
	NewConnection(ctx context.Context) (Connection, error)
	IsConnectionClosedError(err error) bool
}

ConnectorImpl provides a set of methods to manage connections.

type Reconnector

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

Reconnector manages active Connection with automatic retrying and reconnection.

func NewReconnector

func NewReconnector(conn ConnectorImpl) *Reconnector

NewReconnector creates a new Pool for a given connector.

func (*Reconnector) CloseActiveConnection

func (r *Reconnector) CloseActiveConnection(ctx context.Context)

CloseActiveConnection closes the active connection if any.

func (*Reconnector) GetOrOpenConnection

func (r *Reconnector) GetOrOpenConnection(ctx context.Context) (Connection, error)

GetOrOpenConnection gets or establishes new connection and returns it.

func (*Reconnector) UsingConnectionNoResult

func (r *Reconnector) UsingConnectionNoResult(ctx context.Context, desc string, cb func(cli Connection) error) error

UsingConnectionNoResult invokes the provided callback for a Connection.