http

Documentation

Index

• Constants
• func NewServer(address string, aggregator aggregator.Aggregator, opts Options, ...) xserver.Server
• type Options
  • func NewOptions() Options
• type Response
  • func NewResponse() Response
• type StatusResponse
  • func NewStatusResponse() StatusResponse

Constants

const (
	HealthPath = "/health"
	ResignPath = "/resign"
	StatusPath = "/status"
)

A list of HTTP endpoints.

Functions

func NewServer

func NewServer(
	address string,
	aggregator aggregator.Aggregator,
	opts Options,
	iOpts instrument.Options,
) xserver.Server

NewServer creates a new http server.

Types

type Options

type Options interface {
	// SetReadTimeout sets the read timeout.
	SetReadTimeout(value time.Duration) Options

	// ReadTimeout returns the read timeout.
	ReadTimeout() time.Duration

	// SetWriteTimeout sets the write timeout.
	SetWriteTimeout(value time.Duration) Options

	// WriteTimeout returns the write timeout.
	WriteTimeout() time.Duration

	// Mux returns the http mux for the server.
	Mux() *http.ServeMux

	// SetMux sets the http mux for the server.
	SetMux(value *http.ServeMux) Options
}

Options is a set of server options.

func NewOptions

func NewOptions() Options

NewOptions creates a new set of server options.

type Response

type Response struct {
	State string `json:"state,omitempty"`
	Error string `json:"error,omitempty"`
}

Response is an HTTP response.

func NewResponse

func NewResponse() Response

NewResponse creates a new empty response.

type StatusResponse

type StatusResponse struct {
	Response
	Status aggregator.RuntimeStatus `json:"status,omitempty"`
}

StatusResponse is a status response.

func NewStatusResponse

func NewStatusResponse() StatusResponse

NewStatusResponse creates a new empty status response.