From 28b5bf18a3be3b933a76f8b8912c8ee55238cdc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 9 Nov 2017 12:46:23 +0000 Subject: Update documentation for Cowboy 2.1 --- .../cowboy/2.1/manual/cowboy_middleware/index.html | 250 +++++++++++++++++++++ 1 file changed, 250 insertions(+) create mode 100644 docs/en/cowboy/2.1/manual/cowboy_middleware/index.html (limited to 'docs/en/cowboy/2.1/manual/cowboy_middleware/index.html') diff --git a/docs/en/cowboy/2.1/manual/cowboy_middleware/index.html b/docs/en/cowboy/2.1/manual/cowboy_middleware/index.html new file mode 100644 index 00000000..96db75ce --- /dev/null +++ b/docs/en/cowboy/2.1/manual/cowboy_middleware/index.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + Nine Nines: cowboy_middleware(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

cowboy_middleware(3)

+ +
+

Name

+
+

cowboy_middleware - Middlewares

+
+
+
+

Description

+
+

The module cowboy_middleware defines a callback interface for +Cowboy middlewares.

+

Middlewares process the request sequentially in the order they +are configured.

+
+
+
+

Callbacks

+
+

Middlewares implement the following interface:

+
+
+
execute(Req, Env)
+    -> {ok, Req, Env}
+     | {suspend, module(), atom(), [any()]}
+     | {stop, Req}
+
+Req :: cowboy_req:req()
+Env :: cowboy_middleware:env()
+

The execute/2 is the only callback that needs to be +implemented. It must execute the middleware and return +with instructions for Cowboy.

+
+
+ok +
+
+

+Cowboy should continue processing the request using the +returned Req object and environment. +

+
+
+suspend +
+
+

+Cowboy will hibernate the process. When resuming, Cowboy +will apply the returned module, function and arguments. +

+
+
+stop +
+
+

+Cowboy will stop middleware execution. No other middleware +will be executed. This effectively ends the processing of +the request. +

+
+
+
+
+
+

Types

+
+
+

env()

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

Middleware environment.

+

A new environment is created for every request. The initial +environment contained the user configured environment values +(like dispatch for example) plus the listener value which +contains the name of the listener for this connection.

+

Middlewares may modify the environment as necessary.

+
+
+
+
+

Changelog

+
+
    +
  • +

    +2.0: The env type is now a map instead of a proplist. +

    +
    • +
  • +

    +1.0: Behavior introduced. +

    +
    • +
+
+
+
+

See also

+
+

cowboy(7)

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

+ Cowboy + 2.1 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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