Categorygithub.com/apid/goscaffold
modulepackage
0.0.0-20170920224633-8e87c1fe3bd4
Repository: https://github.com/apid/goscaffold.git
Documentation: pkg.go.dev

# Functions

CreateHTTPScaffold makes a new scaffold.
FetchParams fetches the param values, given the params in the request */.
SelectMediaType matches a set of candidate media types against the Accept header in an HTTP request.
SetParamsInRequest Sets the params and its values in the request */.
WriteErrorResponse write a non 200 error response */.

# Constants

DefaultGraceTimeout is the default amount of time to wait for a request to complete.
Failed denotes that the server is bad.
NotReady denotes that the server is OK, but cannot process requests now.
OK denotes that everything is good.

# Variables

ErrManualStop is used when the user doesn't have a reason.
ErrMarkedDown is used after being marked down but before being shut down.
ErrSignalCaught is used in the "Shutdown" mechanism when the shutdown was caused by a SIGINT or SIGTERM.

# Structs

ErrorResponse delivers the errors back to the caller, once validation has failed */.
An HTTPScaffold provides a set of features on top of a standard HTTP listener.

# Interfaces

OAuthService offers interface functions that act on OAuth param, used to verify JWT tokens for the Http handler functions client wishes to validate against (via SSOHandler).

# Type aliases

Errors to return.
HealthChecker is a type of function that an implementer may implement in order to customize what we return from the "health" and "ready" URLs.
HealthStatus is a type of response from a health check.
MarkdownHandler is a type of function that an user may implement in order to be notified when the server is marked down.