package
0.6.5
Repository: https://github.com/chronos-tachyon/roxy.git
Documentation: pkg.go.dev

# Functions

AppVersion returns the application version.
CancelRootContext cancels the root context.
DoneLogging does end-of-program cleanup on the logging subsystem.
GetConnContext retrieves the associated *ConnContext.
InitContext initializes the root context.
InitLogging processes the logging flags and sets up log.Logger.
InitVersion processes the -V/--version flag.
MakeBaseContextFunc returns a "net/http".(*Server).BaseContextFunc that returns the root context.
MakeConnContextFunc returns a "net/http".(*Server).ConnContextFunc that prepares a *ConnContext and calls WithConnContext.
NewDummyZapConfig returns a *zap.Config that logs to zerolog.
NewRotatingLogWriter constructs a new RotatingLogWriter.
RegisterLoggingFlags registers the flags for controlling log output.
RegisterVersionFlag registers the -V/--version flag.
RootContext returns the root context.
RotateLogs rotates the logfile, if that operation makes sense in the current logging configuration.
RoxyVersion returns the version of Roxy itself.
SetAppVersion changes the application version.
WithConnContext attaches the given *ConnContext to the context.

# Constants

ConnContextKey is a context.Context key for *ConnContext.
RequestContextKey is a context.Context key for *RequestContext (app-specific).

# Variables

ErrOperationFailed is a generic error for any failed operation.

# Structs

ATCAnnounceConfig represents the configuration for an *atcclient.ATCClient, plus the fields needed to call announcer.NewATC.
ATCAnnounceConfigJSON represents the JSON doppelgänger of an ATCAnnounceConfig.
ATCClientConfig represents the configuration for an *atcclient.ATCClient.
ATCClientConfigJSON represents the JSON doppelgänger of an ATCClientConfig.
CertKeyError indicates a problem while loading an X.509 certificate/key pair.
CertPoolError indicates a problem while loading an X.509 certificate pool.
ConnContext is data associated with each incoming net.Conn of an http.Server.
EtcdAnnounceConfig represents the configuration for an etcd.io *v3.Client, plus the fields needed to call announcer.NewEtcd.
EtcdAnnounceConfigJSON represents the JSON doppelgänger of an EtcdAnnounceConfig.
EtcdConfig represents the configuration for an etcd.io *v3.Client.
EtcdConfigJSON represents the JSON doppelgänger of an EtcdConfig.
GRPCClientConfig represents the configuration for a *grpc.ClientConn.
GRPCClientConfigJSON represents the JSON doppelgänger of an GRPCClientConfig.
ListenConfig represents the configuration for a net.Listener socket with optional TLS.
ListenConfigJSON represents the JSON doppelgänger of an ListenConfig.
MissingOptionValueError indicates that an option was found with the value elided, but eliding the value doesn't make sense for that option.
MultiServer is a framework that tracks state for long-running servers.
OptionError indicates an error while parsing options.
PromLoggerBridge is a promhttp.Logger that forwards to zerolog.
RotatingLogWriter is an io.WriteCloser that can close and re-open its output file, for logrotate(8) and the like.
TLSClientConfig represents the configuration for a client-oriented *tls.Config object.
TLSClientConfigJSON represents the JSON doppelgänger of an TLSClientConfig.
TLSServerConfig represents the configuration for a server-oriented *tls.Config object.
TLSServerConfigJSON represents the JSON doppelgänger of an TLSServerConfig.
UnknownOptionError indicates that an unknown option was encountered.
ZapLoggerBridge is a zap.Sink that forwards to zerolog.
ZKAddAuthError indicates a problem while authenticating to ZooKeeper.
ZKAnnounceConfig represents the configuration for a *zk.Conn, plus the fields needed to call announcer.NewZK.
ZKAnnounceConfigJSON represents the JSON doppelgänger of an ZKAnnounceConfig.
ZKAuthConfig represents the configuration for (*zk.Conn).AddAuth.
ZKAuthConfigJSON represents the JSON doppelgänger of an ZKAuthConfig.
ZKConfig represents the configuration for a *zk.Conn.
ZKConfigJSON represents the JSON doppelgänger of an ZKConfig.
ZKLoggerBridge is a zk.Logger that forwards to zerolog.

# Type aliases

ExitFunc is the callback type for OnExit hooks.
HealthWatchFunc is the callback type for observing changes in health status.
HealthWatchID tracks a registered HealthWatchFunc callback.
PreRunFunc is the callback type for OnPreRun hooks.
PreShutdownFunc is the callback type for OnPreShutdown hooks.
ReloadFunc is the callback type for OnReload hooks.
RunFunc is the callback type for OnRun hooks.
ShutdownFunc is the callback type for OnShutdown hooks.