From fec98300ec9af6c8b5f3120a60f217983c451076 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 2 May 2018 11:35:26 +0200 Subject: Cowboy 2.4.0 --- docs/en/cowboy/2.4/manual/cowboy_router/index.html | 248 +++++++++++++++++++++ 1 file changed, 248 insertions(+) create mode 100644 docs/en/cowboy/2.4/manual/cowboy_router/index.html (limited to 'docs/en/cowboy/2.4/manual/cowboy_router/index.html') diff --git a/docs/en/cowboy/2.4/manual/cowboy_router/index.html b/docs/en/cowboy/2.4/manual/cowboy_router/index.html new file mode 100644 index 00000000..4e6dcd77 --- /dev/null +++ b/docs/en/cowboy/2.4/manual/cowboy_router/index.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + Nine Nines: cowboy_router(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

cowboy_router(3)

+ +
+

Name

+
+

cowboy_router - Router middleware

+
+
+
+

Description

+
+

The cowboy_router middleware maps the requested host and +path to the handler to be used for processing the request.

+

The router takes the dispatch rules as input from the +middleware environment. Dispatch rules are generated by +calling the +cowboy_router:compile(3) +function.

+

When a route matches, the router sets the handler and +handler_opts middleware environment values containing +the handler module and initial state, respectively.

+

The router will stop execution when no route matches. +It will send a 400 response if no host was found, and +a 404 response otherwise.

+
+
+
+

Exports

+
+
+
+
+
+

Types

+
+
+

bindings()

+
+
+
bindings() :: #{atom() => any()}
+

Bindings found during routing.

+
+
+

dispatch_rules()

+

Opaque type containing the compiled routes.

+
+
+

routes()

+
+
+
routes() = [
+    {Host, PathList} |
+    {Host, Fields, PathList}
+]
+
+PathList :: [
+    {Path, Handler, InitialState} |
+    {Path, Fields, Handler, InitialState}
+]
+
+Host         :: '_' | iodata()
+Path         :: '_' | iodata()
+Fields       :: cowboy:fields()
+Handler      :: module()
+InitialState :: any()
+

Human readable list of routes to handlers.

+

Cowboy uses this list to map hosts and paths, optionally +augmented with constraints applied to the bindings, to +handler modules.

+

The syntax for routes is currently defined in the user guide.

+
+
+

tokens()

+
+
+
tokens() :: [binary()]
+

List of host_info and path_info tokens that were found +using the ... syntax.

+
+
+
+
+

See also

+
+

cowboy(7), +cowboy_req:binding(3), +cowboy_req:bindings(3), +cowboy_req:host_info(3), +cowboy_req:path_info(3)

+
+
+ + + + + +
+ +
+ + +

+ Cowboy + 2.4 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3