gateway

type CertCheckerCommInterface interface {
	GetGatewayTLSCertificate(host *connect.Host,
		message *pb.RequestGatewayCert) (*pb.GatewayCertificate, error)
}

type Filter func(map[id.ID]int, *ndf.NetworkDefinition) map[id.ID]int

type HostManager interface {
	GetHost(hostId *id.ID) (*connect.Host, bool)
	AddHost(hid *id.ID, address string, cert []byte, params connect.HostParams) (
		host *connect.Host, err error)
	RemoveHost(hid *id.ID)
}

type Params struct {
	// MaxPoolSize is the maximum number of Hosts in the HostPool.
	MaxPoolSize uint32

	// PoolSize allows override of HostPool size. Set to zero for dynamic size
	// calculation.
	PoolSize uint32

	// ProxyAttempts dictates how many proxies will be used in event of send
	// failure.
	ProxyAttempts uint32

	// MaxPings is the number of gateways to concurrently test when selecting
	// a new member of HostPool. Must be at least 1.
	MaxPings uint32

	// NumConnectionsWorkers is the number of workers connecting to gateways
	NumConnectionsWorkers int

	// MinBufferLength is the minimum length of input buffers
	// to the hostpool runner
	MinBufferLength uint32

	// EnableRotation enables the system which auto rotates/ gateways regularly.
	// This system will auto disable if the network size is less than 20.
	EnableRotation bool

	// RotationPeriod is how long until a single host is rotated.
	RotationPeriod time.Duration

	// RotationPeriodVariability is the max that the rotation
	// period can randomly deviate from the stated amount
	RotationPeriodVariability time.Duration

	// HostParams is the parameters for the creation of new Host objects.
	HostParams connect.HostParams

	// DebugPrintPeriod is an OPTIONAL field that may be set by the caller.
	// This may be set by the caller when passing Params into NewSender, as an
	// example.
	//
	// This field indicates how often debug prints are printed by the hostPool's
	// long-running thread. These debug prints will contain data on the
	// hostPool's state (refer to debug.go). If this value is not set by the user,
	// then by default debug prints will be disabled.
	DebugPrintPeriod time.Duration

	// GatewayFilter is the function which will be used to filter gateways
	// before connecting.  This must be set before initializing a HostPool and
	// cannot be changed.  If no filter is set, the defaultFilter will be used.
	GatewayFilter Filter
}

type Pool interface {
	Get(id *id.ID) (*connect.Host, bool)
	Has(id *id.ID) bool
	Size() int
	IsReady() error
	GetAny(length uint32, excluded []*id.ID, rng io.Reader) []*connect.Host
	GetSpecific(target *id.ID) (*connect.Host, bool)
	GetPreferred(targets []*id.ID, rng io.Reader) []*connect.Host
}

type SendToPreferredFunc func(host *connect.Host, target *id.ID,
	timeout time.Duration) (interface{}, error)

type Sender interface {
	SendToAny(sendFunc func(host *connect.Host) (interface{}, error),
		stop *stoppable.Single) (interface{}, error)
	SendToPreferred(targets []*id.ID, sendFunc SendToPreferredFunc,
		stop *stoppable.Single, timeout time.Duration) (interface{}, error)
	UpdateNdf(ndf *ndf.NetworkDefinition)
	GetHostParams() connect.HostParams
	StartProcesses() stoppable.Stoppable
}