svcmode

type Config struct {
	// Mode is the effective listener mode. Use ResolveMode to build
	// it from flag/env/SK.
	Mode Mode

	// Stats, when set, counts the service's HTTP requests and its dmsg
	// traffic for its status page (charts.ServiceStats).
	Stats Stats

	// HTTPAddr is the bind address for the http listener
	// (e.g. ":9092"). Required when Mode includes http.
	HTTPAddr string

	// Handler is the http.Handler used for BOTH the http and
	// dmsghttp listeners. Services typically pass their API object
	// directly since it satisfies http.Handler.
	Handler http.Handler

	// DMSG identity. Required when Mode includes dmsg. If SK is
	// null and Mode includes dmsg, Start returns an error.
	PK cipher.PubKey
	SK cipher.SecKey

	// DmsgPort is the dmsghttp listener port. Defaults to
	// dmsg.DefaultDmsgHTTPPort (80) if zero.
	DmsgPort uint16

	// DmsgDiscovery is the plain-HTTP URL of the dmsg-discovery
	// service, used as a fallback for the embedded-server bootstrap
	// and for periodic server-list refresh. Required when Mode
	// includes dmsg unless EmbeddedDmsgServers or DmsgDiscoveryDmsg
	// is non-empty. Ignored when DmsgDiscoveryDmsg is set —
	// deployment services that want strict dmsg-only operation
	// should leave this empty.
	DmsgDiscovery string

	// DmsgDiscoveryDmsg is the dmsg-PK URL of the dmsg-discovery
	// service (form `dmsg://<PK>:<port>`). When set, svcmode routes
	// all discovery RPC over dmsg-HTTP via the bootstrap dmsg client
	// — no plain-HTTP egress to dmsg-discovery occurs. Mutually
	// preferred over DmsgDiscovery; the HTTP field is ignored.
	DmsgDiscoveryDmsg string

	// DmsgServerType, if non-empty, restricts the dmsg client to
	// servers whose ServerType matches (e.g. "official").
	DmsgServerType string

	// EmbeddedDmsgServers is the list of dmsg server entries to use
	// for initial bootstrap. Services should typically pass
	// dmsg.Prod.DmsgServers from the embedded services-config.json.
	EmbeddedDmsgServers []disc.Entry

	// SurveyWhitelist is the list of public keys permitted to
	// access the dmsghttp debug handler (pprof, etc.). Typically
	// deployment.Prod.SurveyWhitelist.
	SurveyWhitelist []cipher.PubKey

	// Log is the shared logger for svcmode bookkeeping and
	// downstream helpers.
	Log *logging.Logger

	// LogHookLevel is the most verbose level kept for /debug/log, info when empty.
	LogHookLevel string

	// OnDmsgServersUpdated, if non-nil, is called periodically with
	// the current list of connected dmsg server PKs. Services that
	// publish this list via their API (e.g. in /health) should set
	// this so svcmode's background poll can keep it fresh.
	OnDmsgServersUpdated func([]string)

	// DmsgServerPollInterval is the interval at which
	// OnDmsgServersUpdated is called. Defaults to 1 second if zero
	// (matching the existing per-service polling loops).
	DmsgServerPollInterval time.Duration

	// DisableDHT is retained as a no-op field for backward compatibility
	// with callers that previously passed it. The DHT subsystem has
	// been removed from the tree; new code should drop the field
	// entirely.
	//
	// Deprecated: no-op.
	DisableDHT bool
}

type Handle struct {
	// DmsgClient is the bootstrap dmsg client or nil when Mode is
	// ModeHTTP. Services that need raw dmsg access (e.g. to spawn
	// a CXO publisher or TPS listener) can use it directly.
	DmsgClient *dmsg.Client

	// Mode is the resolved listener mode.
	Mode Mode
	// contains filtered or unexported fields
}

type Mode string

type Stats interface {
	Handler(http.Handler) http.Handler
	CountDmsg(*dmsg.Client)
	NamePort(port uint16, name string)
}