connhelper

Documentation

Overview

Package connhelper provides helpers for connecting to a remote daemon host with custom logic.

Index

• func Register(scheme string, fn func(*url.URL) (*ConnectionHelper, error))
• type ConnectionHelper
  • func GetConnectionHelper(daemonURL string) (*ConnectionHelper, error)

Functions

func Register

func Register(scheme string, fn func(*url.URL) (*ConnectionHelper, error))

Register registers new connectionhelper for scheme

Types

type ConnectionHelper

type ConnectionHelper struct {
	// ContextDialer can be passed to grpc.WithContextDialer
	ContextDialer func(ctx context.Context, addr string) (net.Conn, error)
}

ConnectionHelper allows to connect to a remote host with custom stream provider binary.

func GetConnectionHelper

func GetConnectionHelper(daemonURL string) (*ConnectionHelper, error)

GetConnectionHelper returns BuildKit-specific connection helper for the given URL. GetConnectionHelper returns nil without error when no helper is registered for the scheme.