From 48f39402181d959cad88cb3f460210c007169f50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 12 May 2021 11:13:47 +0200 Subject: Cowboy 2.9.0 --- .../en/cowboy/2.3/manual/cowboy.set_env/index.html | 211 --------------------- 1 file changed, 211 deletions(-) delete mode 100644 docs/en/cowboy/2.3/manual/cowboy.set_env/index.html (limited to 'docs/en/cowboy/2.3/manual/cowboy.set_env/index.html') diff --git a/docs/en/cowboy/2.3/manual/cowboy.set_env/index.html b/docs/en/cowboy/2.3/manual/cowboy.set_env/index.html deleted file mode 100644 index db0862c5..00000000 --- a/docs/en/cowboy/2.3/manual/cowboy.set_env/index.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - - - - Nine Nines: cowboy:set_env(3) - - - - - - - - - - - - - - -

- - - -

- -

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).

99s

cowboy:set_env(3)

Name

Description

Arguments

Return value

Changelog

Examples

See also

- Cowboy - 2.3 - Function Reference - -

Navigation

Version select

Like my work? Donate!