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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 ¶ added in v1.12.0
func Cancellable(r Route) Route
Cancellable makes new route which embeds http.CloseNotifier feature to context.Context of handler.
func NewDeleteRoute ¶ added in v1.11.0
func NewDeleteRoute(path string, handler httputils.APIFunc) Route
NewDeleteRoute initializes a new route with the http method DELETE.
func NewGetRoute ¶ added in v1.11.0
func NewGetRoute(path string, handler httputils.APIFunc) Route
NewGetRoute initializes a new route with the http method GET.
func NewHeadRoute ¶ added in v1.11.0
func NewHeadRoute(path string, handler httputils.APIFunc) Route
NewHeadRoute initializes a new route with the http method HEAD.
func NewOptionsRoute ¶ added in v1.11.0
func NewOptionsRoute(path string, handler httputils.APIFunc) Route
NewOptionsRoute initializes a new route with the http method OPTIONS.
func NewPostRoute ¶ added in v1.11.0
func NewPostRoute(path string, handler httputils.APIFunc) Route
NewPostRoute initializes a new route with the http method POST.
func NewPutRoute ¶ added in v1.11.0
func NewPutRoute(path string, handler httputils.APIFunc) Route
NewPutRoute initializes a new route with the http method PUT.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.