From 83f1ad46e84c1a9016c9dee2c1ec749880dfd260 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 1 Oct 2016 00:08:31 +0200 Subject: HTTPS fixes and link:man support in docs + doc update --- .../en/cowboy/2.0/manual/cowboy.set_env/index.html | 255 +++++++++++++++++++++ 1 file changed, 255 insertions(+) create mode 100644 docs/en/cowboy/2.0/manual/cowboy.set_env/index.html (limited to 'docs/en/cowboy/2.0/manual/cowboy.set_env') diff --git a/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html new file mode 100644 index 00000000..bce57e3c --- /dev/null +++ b/docs/en/cowboy/2.0/manual/cowboy.set_env/index.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + Nine Nines: cowboy:set_env(3) + + + + + + + + + + + + + + + + +
+
+
+
+

99s

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

cowboy:set_env(3)

+ +
+

Name

+
+

cowboy:set_env - Update a listener’s environment value

+
+
+
+

Description

+
+
+
+
set_env(Name  :: ranch:ref(),
+        Key   :: atom(),
+        Value :: any())
+    -> ok
+

Set or update an environment value for a previously started +listener.

+

This is most useful for updating the routes dynamically, +without having to restart the listener.

+

The new value will only be available to new connections. +Pre-existing connections will still use the old value.

+
+
+
+

Arguments

+
+
+
+Name +
+
+

+The name of the listener to update. +

+

The name of the listener is the first argument given to the +cowboy:start_clear(3), +cowboy:start_tls(3) or +ranch:start_listener(3) function.

+
+
+Key +
+
+

+The key in the environment map. Common keys include dispatch +and middlewares. +

+
+
+Value +
+
+

+The new value. +

+
+
+

The type of the value differs depending on the key.

+
+
+
+

Return value

+
+

The atom ok is returned on success.

+

An exit:badarg exception is thrown when the listener does +not exist.

+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Update a listener’s routes
+
+
Dispatch = cowboy_router:compile([
+    {'_', [
+        {"/", toppage_h, []},
+        {"/ws", websocket_h, []}
+    ]}
+]),
+
+cowboy:set_env(example, dispatch, Dispatch).
+
+
+
+

See also

+
+

cowboy(3), +cowboy:start_clear(3), +cowboy:start_tls(3), +ranch:set_protocol_options(3)

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

+ Cowboy + 2.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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