client

Documentation

Index

• func Dial(ctx context.Context, rawAddress string, opts ...DialOption) (*grpc.ClientConn, error)
• type DialOption
  • func WithGrpcOptions(opts []grpc.DialOption) DialOption
  • func WithHandshaker(handshaker Handshaker) DialOption
  • func WithTransportCredentials(creds credentials.TransportCredentials) DialOption
• type Dialer
• type Handshaker
• type Pool
  • func NewPool(opts ...PoolOption) *Pool
  • func (p *Pool) Close() error
  • func (p *Pool) Dial(ctx context.Context, address, token string) (*grpc.ClientConn, error)
• type PoolOption
  • func WithDialOptions(dialOptions ...grpc.DialOption) PoolOption
  • func WithDialer(dialer Dialer) PoolOption

Functions

func Dial

func Dial(ctx context.Context, rawAddress string, opts ...DialOption) (*grpc.ClientConn, error)

Dial dials a Gitaly node serving at the given address. Dial is used by the public 'client' package and the expected behavior is mostly documented there.

Types

type DialOption

type DialOption func(*dialConfig)

DialOption is an option that can be passed to Dial.

func WithGrpcOptions

func WithGrpcOptions(opts []grpc.DialOption) DialOption

WithGrpcOptions will set up the given gRPC dial options so that they will be used when calling `grpc.NewClient()`.

func WithHandshaker

func WithHandshaker(handshaker Handshaker) DialOption

WithHandshaker sets up the given handshaker so that it's passed as the transport credentials which would be otherwise set. The transport credentials returned by handshaker are then set instead.

func WithTransportCredentials

func WithTransportCredentials(creds credentials.TransportCredentials) DialOption

WithTransportCredentials sets up the given credentials. By default, non-TLS connections will use insecure credentials whereas TLS connections will use the x509 system certificate pool. This option allows callers to override these defaults.

type Dialer

type Dialer func(ctx context.Context, address string, opts []grpc.DialOption) (*grpc.ClientConn, error)

Dialer is a dialer used to create new connections.

type Handshaker

type Handshaker interface {
	// ClientHandshake wraps the provided credentials and returns new credentials.
	ClientHandshake(credentials.TransportCredentials) credentials.TransportCredentials
}

Handshaker is an interface that allows for wrapping the transport credentials with a custom handshake.

type Pool

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

Pool is a pool of GRPC connections. Connections created by it are safe for concurrent use.

func NewPool

func NewPool(opts ...PoolOption) *Pool

NewPool creates a new connection pool that's ready for use.

func (*Pool) Close

func (p *Pool) Close() error

Close closes all connections tracked by the connection pool.

func (*Pool) Dial

func (p *Pool) Dial(ctx context.Context, address, token string) (*grpc.ClientConn, error)

Dial creates a new client connection in case no connection to the given address exists already or returns an already established connection. The returned address must not be `Close()`d.

type PoolOption

type PoolOption func(*poolConfig)

PoolOption is an option that can be passed to NewPool.

func WithDialOptions

func WithDialOptions(dialOptions ...grpc.DialOption) PoolOption

WithDialOptions sets gRPC options to use for the gRPC Dial call.

func WithDialer

func WithDialer(dialer Dialer) PoolOption

WithDialer sets the dialer that is called for each new gRPC connection the pool establishes.