serve

Documentation

Overview

Package serve provides helpers to start and shutdown network services.

Index

• func HTTP(ctx Ctx, addr netx.Addr, handler http.Handler, service string) error
• func Metrics(ctx Ctx, addr netx.Addr, reg *prometheus.Registry) error
• func OpenAPI(ctx Ctx, srv OpenAPIServer, service string) error
• type Ctx
• type OpenAPIServer

Functions

func HTTP

func HTTP(ctx Ctx, addr netx.Addr, handler http.Handler, service string) error

HTTP starts HTTP server on addr using handler logged as service. It runs until failed or ctx.Done.

func Metrics

func Metrics(ctx Ctx, addr netx.Addr, reg *prometheus.Registry) error

Metrics starts HTTP server on addr path /metrics using reg as prometheus handler.

func OpenAPI

func OpenAPI(ctx Ctx, srv OpenAPIServer, service string) error

OpenAPI starts HTTP/HTTPS server using srv logged as service. It runs until failed or ctx.Done.

Types

type Ctx

type Ctx = context.Context

Ctx is a synonym for convenience.

type OpenAPIServer

type OpenAPIServer interface {
	HTTPListener() (net.Listener, error)
	TLSListener() (net.Listener, error)
	Serve() error
	Shutdown() error
}

OpenAPIServer implemented by *restapi.Server generated by go-swagger.