mirror of https://github.com/status-im/consul.git
43 lines
1.8 KiB
Go
43 lines
1.8 KiB
Go
// Package proxy contains logic for agent interaction with proxies,
|
|
// primarily "managed" proxies. Managed proxies are proxy processes for
|
|
// Connect-compatible endpoints that Consul owns and controls the lifecycle
|
|
// for.
|
|
//
|
|
// This package does not contain the built-in proxy for Connect. The source
|
|
// for that is available in the "connect/proxy" package.
|
|
package proxy
|
|
|
|
// EnvProxyToken is the name of the environment variable that is passed
|
|
// to managed proxies containing the proxy token.
|
|
const EnvProxyToken = "CONNECT_PROXY_TOKEN"
|
|
|
|
// Proxy is the interface implemented by all types of managed proxies.
|
|
//
|
|
// Calls to all the functions on this interface must be concurrency safe.
|
|
// Please read the documentation carefully on top of each function for expected
|
|
// behavior.
|
|
type Proxy interface {
|
|
// Start starts the proxy. If an error is returned then the managed
|
|
// proxy registration is rejected. Therefore, this should only fail if
|
|
// the configuration of the proxy itself is irrecoverable, and should
|
|
// retry starting for other failures.
|
|
//
|
|
// Starting an already-started proxy should not return an error.
|
|
Start() error
|
|
|
|
// Stop stops the proxy and disallows it from ever being started again.
|
|
//
|
|
// If the proxy is not started yet, this should not return an error, but
|
|
// it should disallow Start from working again. If the proxy is already
|
|
// stopped, this should not return an error.
|
|
Stop() error
|
|
|
|
// Equal returns true if the argument is equal to the proxy being called.
|
|
// This is called by the manager to determine if a change in configuration
|
|
// results in a proxy that needs to be restarted or not. If Equal returns
|
|
// false, then the manager will stop the old proxy and start the new one.
|
|
// If Equal returns true, the old proxy will remain running and the new
|
|
// one will be ignored.
|
|
Equal(Proxy) bool
|
|
}
|