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 Handshaker

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.DialContext()`.

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 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.