connhelper

Documentation

Overview

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

Index

• type ConnectionHelper
  • func GetCommandConnectionHelper(cmd string, flags ...string) (*ConnectionHelper, error)
  • func GetConnectionHelper(daemonURL string) (*ConnectionHelper, error)

Types

type ConnectionHelper

type ConnectionHelper struct {
	Dialer func(ctx context.Context, network, addr string) (net.Conn, error)
	Host   string // dummy URL used for HTTP requests. e.g. "http://docker"
}

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

func GetCommandConnectionHelper

func GetCommandConnectionHelper(cmd string, flags ...string) (*ConnectionHelper, error)

GetCommandConnectionHelper returns Docker-specific connection helper constructed from an arbitrary command.

func GetConnectionHelper

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

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

ssh://<user>@<host> URL requires Docker 18.09 or later on the remote host.