router

Documentation

Index

• type Route
  • func Cancellable(r Route) Route
  • func NewDeleteRoute(path string, handler httputils.APIFunc) Route
  • func NewGetRoute(path string, handler httputils.APIFunc) Route
  • func NewHeadRoute(path string, handler httputils.APIFunc) Route
  • func NewOptionsRoute(path string, handler httputils.APIFunc) Route
  • func NewPostRoute(path string, handler httputils.APIFunc) Route
  • func NewPutRoute(path string, handler httputils.APIFunc) Route
  • func NewRoute(method, path string, handler httputils.APIFunc) Route
• type Router

Types

type Route

type Route interface {
	// Handler returns the raw function to create the http handler.
	Handler() httputils.APIFunc
	// Method returns the http method that the route responds to.
	Method() string
	// Path returns the subpath where the route responds to.
	Path() string
}

Route defines an individual API route in the docker server.

func Cancellable

func Cancellable(r Route) Route

Cancellable makes new route which embeds http.CloseNotifier feature to context.Context of handler.

func NewDeleteRoute

func NewDeleteRoute(path string, handler httputils.APIFunc) Route

NewDeleteRoute initializes a new route with the http method DELETE.

func NewGetRoute

func NewGetRoute(path string, handler httputils.APIFunc) Route

NewGetRoute initializes a new route with the http method GET.

func NewHeadRoute

func NewHeadRoute(path string, handler httputils.APIFunc) Route

NewHeadRoute initializes a new route with the http method HEAD.

func NewOptionsRoute

func NewOptionsRoute(path string, handler httputils.APIFunc) Route

NewOptionsRoute initializes a new route with the http method OPTIONS.

func NewPostRoute

func NewPostRoute(path string, handler httputils.APIFunc) Route

NewPostRoute initializes a new route with the http method POST.

func NewPutRoute

func NewPutRoute(path string, handler httputils.APIFunc) Route

NewPutRoute initializes a new route with the http method PUT.

func NewRoute

func NewRoute(method, path string, handler httputils.APIFunc) Route

NewRoute initializes a new local route for the router.

type Router

type Router interface {
	// Routes returns the list of routes to add to the docker server.
	Routes() []Route
}

Router defines an interface to specify a group of routes to add to the docker server.