diff options
| author | Loïc Hoguin <[email protected]> | 2019-09-26 14:05:08 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2019-09-26 14:05:08 +0200 |
| commit | e39252ae5048156ac33999ce9bb07212798b6b80 (patch) | |
| tree | e1659087748735d3e3ae223900c9b262446d2ef5 /docs/en/gun | |
| parent | a710610c03c8b3dc78214f1a37abc9907eb3f5a8 (diff) | |
| download | ninenines.eu-e39252ae5048156ac33999ce9bb07212798b6b80.tar.gz ninenines.eu-e39252ae5048156ac33999ce9bb07212798b6b80.tar.bz2 ninenines.eu-e39252ae5048156ac33999ce9bb07212798b6b80.zip | |
Add Gun 2.0-pre documentation
But don't propagate via RSS.
Diffstat (limited to 'docs/en/gun')
228 files changed, 12721 insertions, 0 deletions
diff --git a/docs/en/gun/1.0/guide/connect/index.html b/docs/en/gun/1.0/guide/connect/index.html index 9fd2cb64..24d62fff 100644 --- a/docs/en/gun/1.0/guide/connect/index.html +++ b/docs/en/gun/1.0/guide/connect/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.0/guide/http/index.html b/docs/en/gun/1.0/guide/http/index.html index fa56687a..0fd7edea 100644 --- a/docs/en/gun/1.0/guide/http/index.html +++ b/docs/en/gun/1.0/guide/http/index.html @@ -391,6 +391,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.0/guide/index.html b/docs/en/gun/1.0/guide/index.html index 3744cac8..d9e4b2dc 100644 --- a/docs/en/gun/1.0/guide/index.html +++ b/docs/en/gun/1.0/guide/index.html @@ -110,6 +110,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.0/guide/introduction/index.html b/docs/en/gun/1.0/guide/introduction/index.html index ec9a5445..b5d9df89 100644 --- a/docs/en/gun/1.0/guide/introduction/index.html +++ b/docs/en/gun/1.0/guide/introduction/index.html @@ -143,6 +143,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.0/guide/protocols/index.html b/docs/en/gun/1.0/guide/protocols/index.html index 37e50525..19b838bc 100644 --- a/docs/en/gun/1.0/guide/protocols/index.html +++ b/docs/en/gun/1.0/guide/protocols/index.html @@ -270,6 +270,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.0/guide/start/index.html b/docs/en/gun/1.0/guide/start/index.html index b04f42f1..54908b09 100644 --- a/docs/en/gun/1.0/guide/start/index.html +++ b/docs/en/gun/1.0/guide/start/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.0/guide/websocket/index.html b/docs/en/gun/1.0/guide/websocket/index.html index 79ef227e..c2e93866 100644 --- a/docs/en/gun/1.0/guide/websocket/index.html +++ b/docs/en/gun/1.0/guide/websocket/index.html @@ -196,6 +196,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.await/index.html b/docs/en/gun/1.0/manual/gun.await/index.html index 2f2179d1..9212d186 100644 --- a/docs/en/gun/1.0/manual/gun.await/index.html +++ b/docs/en/gun/1.0/manual/gun.await/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.await_body/index.html b/docs/en/gun/1.0/manual/gun.await_body/index.html index 6b248eb6..a5e3f249 100644 --- a/docs/en/gun/1.0/manual/gun.await_body/index.html +++ b/docs/en/gun/1.0/manual/gun.await_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.await_up/index.html b/docs/en/gun/1.0/manual/gun.await_up/index.html index 3c35b64f..daa117f9 100644 --- a/docs/en/gun/1.0/manual/gun.await_up/index.html +++ b/docs/en/gun/1.0/manual/gun.await_up/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.cancel/index.html b/docs/en/gun/1.0/manual/gun.cancel/index.html index bf57d868..9b31215d 100644 --- a/docs/en/gun/1.0/manual/gun.cancel/index.html +++ b/docs/en/gun/1.0/manual/gun.cancel/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.close/index.html b/docs/en/gun/1.0/manual/gun.close/index.html index 48e80f52..ac219ffe 100644 --- a/docs/en/gun/1.0/manual/gun.close/index.html +++ b/docs/en/gun/1.0/manual/gun.close/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.data/index.html b/docs/en/gun/1.0/manual/gun.data/index.html index 5a2ac587..92f4562b 100644 --- a/docs/en/gun/1.0/manual/gun.data/index.html +++ b/docs/en/gun/1.0/manual/gun.data/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.delete/index.html b/docs/en/gun/1.0/manual/gun.delete/index.html index 35c72817..d0588332 100644 --- a/docs/en/gun/1.0/manual/gun.delete/index.html +++ b/docs/en/gun/1.0/manual/gun.delete/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.flush/index.html b/docs/en/gun/1.0/manual/gun.flush/index.html index c38497f2..994e95a2 100644 --- a/docs/en/gun/1.0/manual/gun.flush/index.html +++ b/docs/en/gun/1.0/manual/gun.flush/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.get/index.html b/docs/en/gun/1.0/manual/gun.get/index.html index 130e435b..ed91978b 100644 --- a/docs/en/gun/1.0/manual/gun.get/index.html +++ b/docs/en/gun/1.0/manual/gun.get/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.head/index.html b/docs/en/gun/1.0/manual/gun.head/index.html index 33ed5604..9117883c 100644 --- a/docs/en/gun/1.0/manual/gun.head/index.html +++ b/docs/en/gun/1.0/manual/gun.head/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.info/index.html b/docs/en/gun/1.0/manual/gun.info/index.html index 3bc8a284..6af93f15 100644 --- a/docs/en/gun/1.0/manual/gun.info/index.html +++ b/docs/en/gun/1.0/manual/gun.info/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.open/index.html b/docs/en/gun/1.0/manual/gun.open/index.html index f22fc58e..9d5a9f63 100644 --- a/docs/en/gun/1.0/manual/gun.open/index.html +++ b/docs/en/gun/1.0/manual/gun.open/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.open_unix/index.html b/docs/en/gun/1.0/manual/gun.open_unix/index.html index 52930184..8190ad90 100644 --- a/docs/en/gun/1.0/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.0/manual/gun.open_unix/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.options/index.html b/docs/en/gun/1.0/manual/gun.options/index.html index 91749650..8c5f1d00 100644 --- a/docs/en/gun/1.0/manual/gun.options/index.html +++ b/docs/en/gun/1.0/manual/gun.options/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.patch/index.html b/docs/en/gun/1.0/manual/gun.patch/index.html index 131e5e7d..4e49d36e 100644 --- a/docs/en/gun/1.0/manual/gun.patch/index.html +++ b/docs/en/gun/1.0/manual/gun.patch/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.post/index.html b/docs/en/gun/1.0/manual/gun.post/index.html index 5e4821b8..a4a4b76a 100644 --- a/docs/en/gun/1.0/manual/gun.post/index.html +++ b/docs/en/gun/1.0/manual/gun.post/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.put/index.html b/docs/en/gun/1.0/manual/gun.put/index.html index 40841942..f567d1ba 100644 --- a/docs/en/gun/1.0/manual/gun.put/index.html +++ b/docs/en/gun/1.0/manual/gun.put/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.request/index.html b/docs/en/gun/1.0/manual/gun.request/index.html index ce3d7c40..27cd43c8 100644 --- a/docs/en/gun/1.0/manual/gun.request/index.html +++ b/docs/en/gun/1.0/manual/gun.request/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.ws_send/index.html b/docs/en/gun/1.0/manual/gun.ws_send/index.html index 18babe00..52edb5e7 100644 --- a/docs/en/gun/1.0/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.0/manual/gun.ws_send/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html index bd7fc160..0634c2c8 100644 --- a/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun/index.html b/docs/en/gun/1.0/manual/gun/index.html index f8a8df16..43a55935 100644 --- a/docs/en/gun/1.0/manual/gun/index.html +++ b/docs/en/gun/1.0/manual/gun/index.html @@ -309,6 +309,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_app/index.html b/docs/en/gun/1.0/manual/gun_app/index.html index b3ce361f..10a4799a 100644 --- a/docs/en/gun/1.0/manual/gun_app/index.html +++ b/docs/en/gun/1.0/manual/gun_app/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_data/index.html b/docs/en/gun/1.0/manual/gun_data/index.html index 9030cee1..f79277c5 100644 --- a/docs/en/gun/1.0/manual/gun_data/index.html +++ b/docs/en/gun/1.0/manual/gun_data/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_down/index.html b/docs/en/gun/1.0/manual/gun_down/index.html index e842807e..2e37bb72 100644 --- a/docs/en/gun/1.0/manual/gun_down/index.html +++ b/docs/en/gun/1.0/manual/gun_down/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_error/index.html b/docs/en/gun/1.0/manual/gun_error/index.html index 7d76a468..823ed9e3 100644 --- a/docs/en/gun/1.0/manual/gun_error/index.html +++ b/docs/en/gun/1.0/manual/gun_error/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_inform/index.html b/docs/en/gun/1.0/manual/gun_inform/index.html index 756454a6..49987b19 100644 --- a/docs/en/gun/1.0/manual/gun_inform/index.html +++ b/docs/en/gun/1.0/manual/gun_inform/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_push/index.html b/docs/en/gun/1.0/manual/gun_push/index.html index 14697fdd..5cceeec0 100644 --- a/docs/en/gun/1.0/manual/gun_push/index.html +++ b/docs/en/gun/1.0/manual/gun_push/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_response/index.html b/docs/en/gun/1.0/manual/gun_response/index.html index b73e99c5..3bdf324a 100644 --- a/docs/en/gun/1.0/manual/gun_response/index.html +++ b/docs/en/gun/1.0/manual/gun_response/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_trailers/index.html b/docs/en/gun/1.0/manual/gun_trailers/index.html index 2ed4b357..17f2223c 100644 --- a/docs/en/gun/1.0/manual/gun_trailers/index.html +++ b/docs/en/gun/1.0/manual/gun_trailers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_up/index.html b/docs/en/gun/1.0/manual/gun_up/index.html index 7bcd673d..a26fc55b 100644 --- a/docs/en/gun/1.0/manual/gun_up/index.html +++ b/docs/en/gun/1.0/manual/gun_up/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_upgrade/index.html b/docs/en/gun/1.0/manual/gun_upgrade/index.html index bdd77442..f2a1c6da 100644 --- a/docs/en/gun/1.0/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.0/manual/gun_upgrade/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/gun_ws/index.html b/docs/en/gun/1.0/manual/gun_ws/index.html index f2598c68..5f4d66ec 100644 --- a/docs/en/gun/1.0/manual/gun_ws/index.html +++ b/docs/en/gun/1.0/manual/gun_ws/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.0/manual/index.html b/docs/en/gun/1.0/manual/index.html index fc99f058..6905f4b2 100644 --- a/docs/en/gun/1.0/manual/index.html +++ b/docs/en/gun/1.0/manual/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/connect/index.html b/docs/en/gun/1.1/guide/connect/index.html index e634da7e..7aa168b1 100644 --- a/docs/en/gun/1.1/guide/connect/index.html +++ b/docs/en/gun/1.1/guide/connect/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/http/index.html b/docs/en/gun/1.1/guide/http/index.html index fca530ef..59cfb9a1 100644 --- a/docs/en/gun/1.1/guide/http/index.html +++ b/docs/en/gun/1.1/guide/http/index.html @@ -391,6 +391,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/index.html b/docs/en/gun/1.1/guide/index.html index 4d68836f..283474a2 100644 --- a/docs/en/gun/1.1/guide/index.html +++ b/docs/en/gun/1.1/guide/index.html @@ -115,6 +115,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/introduction/index.html b/docs/en/gun/1.1/guide/introduction/index.html index 607deffa..71136d08 100644 --- a/docs/en/gun/1.1/guide/introduction/index.html +++ b/docs/en/gun/1.1/guide/introduction/index.html @@ -143,6 +143,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/migrating_from_1.0/index.html b/docs/en/gun/1.1/guide/migrating_from_1.0/index.html index d844673a..c5b7f059 100644 --- a/docs/en/gun/1.1/guide/migrating_from_1.0/index.html +++ b/docs/en/gun/1.1/guide/migrating_from_1.0/index.html @@ -128,6 +128,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/protocols/index.html b/docs/en/gun/1.1/guide/protocols/index.html index d567a71b..c8406384 100644 --- a/docs/en/gun/1.1/guide/protocols/index.html +++ b/docs/en/gun/1.1/guide/protocols/index.html @@ -270,6 +270,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/start/index.html b/docs/en/gun/1.1/guide/start/index.html index 8652025f..4a7f7702 100644 --- a/docs/en/gun/1.1/guide/start/index.html +++ b/docs/en/gun/1.1/guide/start/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/guide/websocket/index.html b/docs/en/gun/1.1/guide/websocket/index.html index d0d870af..6ffbda96 100644 --- a/docs/en/gun/1.1/guide/websocket/index.html +++ b/docs/en/gun/1.1/guide/websocket/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.await/index.html b/docs/en/gun/1.1/manual/gun.await/index.html index 9677a82f..14fbe6eb 100644 --- a/docs/en/gun/1.1/manual/gun.await/index.html +++ b/docs/en/gun/1.1/manual/gun.await/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.await_body/index.html b/docs/en/gun/1.1/manual/gun.await_body/index.html index f5c181cd..2e78031e 100644 --- a/docs/en/gun/1.1/manual/gun.await_body/index.html +++ b/docs/en/gun/1.1/manual/gun.await_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.await_up/index.html b/docs/en/gun/1.1/manual/gun.await_up/index.html index 82d817ab..b971e083 100644 --- a/docs/en/gun/1.1/manual/gun.await_up/index.html +++ b/docs/en/gun/1.1/manual/gun.await_up/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.cancel/index.html b/docs/en/gun/1.1/manual/gun.cancel/index.html index 175c2f28..5ff64617 100644 --- a/docs/en/gun/1.1/manual/gun.cancel/index.html +++ b/docs/en/gun/1.1/manual/gun.cancel/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.close/index.html b/docs/en/gun/1.1/manual/gun.close/index.html index ff396e62..9e8e5b42 100644 --- a/docs/en/gun/1.1/manual/gun.close/index.html +++ b/docs/en/gun/1.1/manual/gun.close/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.data/index.html b/docs/en/gun/1.1/manual/gun.data/index.html index 25633b8c..15a574f8 100644 --- a/docs/en/gun/1.1/manual/gun.data/index.html +++ b/docs/en/gun/1.1/manual/gun.data/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.delete/index.html b/docs/en/gun/1.1/manual/gun.delete/index.html index 2021a352..ed89a6ab 100644 --- a/docs/en/gun/1.1/manual/gun.delete/index.html +++ b/docs/en/gun/1.1/manual/gun.delete/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.flush/index.html b/docs/en/gun/1.1/manual/gun.flush/index.html index b426d793..351512fe 100644 --- a/docs/en/gun/1.1/manual/gun.flush/index.html +++ b/docs/en/gun/1.1/manual/gun.flush/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.get/index.html b/docs/en/gun/1.1/manual/gun.get/index.html index cac4ef56..4fcbe6d4 100644 --- a/docs/en/gun/1.1/manual/gun.get/index.html +++ b/docs/en/gun/1.1/manual/gun.get/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.head/index.html b/docs/en/gun/1.1/manual/gun.head/index.html index 1e2c037d..cab1c923 100644 --- a/docs/en/gun/1.1/manual/gun.head/index.html +++ b/docs/en/gun/1.1/manual/gun.head/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.info/index.html b/docs/en/gun/1.1/manual/gun.info/index.html index cd19e6ac..86d1ce94 100644 --- a/docs/en/gun/1.1/manual/gun.info/index.html +++ b/docs/en/gun/1.1/manual/gun.info/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.open/index.html b/docs/en/gun/1.1/manual/gun.open/index.html index e219c3bc..31627af8 100644 --- a/docs/en/gun/1.1/manual/gun.open/index.html +++ b/docs/en/gun/1.1/manual/gun.open/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.open_unix/index.html b/docs/en/gun/1.1/manual/gun.open_unix/index.html index e5f68487..88e7209c 100644 --- a/docs/en/gun/1.1/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.1/manual/gun.open_unix/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.options/index.html b/docs/en/gun/1.1/manual/gun.options/index.html index 8210c28c..d17789da 100644 --- a/docs/en/gun/1.1/manual/gun.options/index.html +++ b/docs/en/gun/1.1/manual/gun.options/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.patch/index.html b/docs/en/gun/1.1/manual/gun.patch/index.html index dc2b1b18..3d27fbc7 100644 --- a/docs/en/gun/1.1/manual/gun.patch/index.html +++ b/docs/en/gun/1.1/manual/gun.patch/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.post/index.html b/docs/en/gun/1.1/manual/gun.post/index.html index 65774928..57b73182 100644 --- a/docs/en/gun/1.1/manual/gun.post/index.html +++ b/docs/en/gun/1.1/manual/gun.post/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.put/index.html b/docs/en/gun/1.1/manual/gun.put/index.html index c8c8d307..6e3ec792 100644 --- a/docs/en/gun/1.1/manual/gun.put/index.html +++ b/docs/en/gun/1.1/manual/gun.put/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.request/index.html b/docs/en/gun/1.1/manual/gun.request/index.html index b99e4c9b..61733c36 100644 --- a/docs/en/gun/1.1/manual/gun.request/index.html +++ b/docs/en/gun/1.1/manual/gun.request/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.ws_send/index.html b/docs/en/gun/1.1/manual/gun.ws_send/index.html index 4420cab3..4f3a3550 100644 --- a/docs/en/gun/1.1/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.1/manual/gun.ws_send/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html index e6a18fa0..bd980358 100644 --- a/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.1/manual/gun.ws_upgrade/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun/index.html b/docs/en/gun/1.1/manual/gun/index.html index 65ba1b1e..e3849bdb 100644 --- a/docs/en/gun/1.1/manual/gun/index.html +++ b/docs/en/gun/1.1/manual/gun/index.html @@ -309,6 +309,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_app/index.html b/docs/en/gun/1.1/manual/gun_app/index.html index 14812d86..5456bcaa 100644 --- a/docs/en/gun/1.1/manual/gun_app/index.html +++ b/docs/en/gun/1.1/manual/gun_app/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_data/index.html b/docs/en/gun/1.1/manual/gun_data/index.html index 77ac6fbb..8aa2517e 100644 --- a/docs/en/gun/1.1/manual/gun_data/index.html +++ b/docs/en/gun/1.1/manual/gun_data/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_down/index.html b/docs/en/gun/1.1/manual/gun_down/index.html index 6401c0e7..a865c5fe 100644 --- a/docs/en/gun/1.1/manual/gun_down/index.html +++ b/docs/en/gun/1.1/manual/gun_down/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_error/index.html b/docs/en/gun/1.1/manual/gun_error/index.html index e363b519..38d347b5 100644 --- a/docs/en/gun/1.1/manual/gun_error/index.html +++ b/docs/en/gun/1.1/manual/gun_error/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_inform/index.html b/docs/en/gun/1.1/manual/gun_inform/index.html index b11ab360..22d8ecd2 100644 --- a/docs/en/gun/1.1/manual/gun_inform/index.html +++ b/docs/en/gun/1.1/manual/gun_inform/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_push/index.html b/docs/en/gun/1.1/manual/gun_push/index.html index 0b71295f..732669a4 100644 --- a/docs/en/gun/1.1/manual/gun_push/index.html +++ b/docs/en/gun/1.1/manual/gun_push/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_response/index.html b/docs/en/gun/1.1/manual/gun_response/index.html index 0ee79622..11363a8a 100644 --- a/docs/en/gun/1.1/manual/gun_response/index.html +++ b/docs/en/gun/1.1/manual/gun_response/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_trailers/index.html b/docs/en/gun/1.1/manual/gun_trailers/index.html index 5c75225b..47380ce1 100644 --- a/docs/en/gun/1.1/manual/gun_trailers/index.html +++ b/docs/en/gun/1.1/manual/gun_trailers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_up/index.html b/docs/en/gun/1.1/manual/gun_up/index.html index b63aaad7..da857c59 100644 --- a/docs/en/gun/1.1/manual/gun_up/index.html +++ b/docs/en/gun/1.1/manual/gun_up/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_upgrade/index.html b/docs/en/gun/1.1/manual/gun_upgrade/index.html index cb5c8613..37f89658 100644 --- a/docs/en/gun/1.1/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.1/manual/gun_upgrade/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/gun_ws/index.html b/docs/en/gun/1.1/manual/gun_ws/index.html index 9f7f7442..1526ed4c 100644 --- a/docs/en/gun/1.1/manual/gun_ws/index.html +++ b/docs/en/gun/1.1/manual/gun_ws/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.1/manual/index.html b/docs/en/gun/1.1/manual/index.html index 84bc7c6a..26898308 100644 --- a/docs/en/gun/1.1/manual/index.html +++ b/docs/en/gun/1.1/manual/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/connect/index.html b/docs/en/gun/1.2/guide/connect/index.html index d4ab1f88..8b7dc3cd 100644 --- a/docs/en/gun/1.2/guide/connect/index.html +++ b/docs/en/gun/1.2/guide/connect/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/http/index.html b/docs/en/gun/1.2/guide/http/index.html index 8c057341..d6e8e67c 100644 --- a/docs/en/gun/1.2/guide/http/index.html +++ b/docs/en/gun/1.2/guide/http/index.html @@ -391,6 +391,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/index.html b/docs/en/gun/1.2/guide/index.html index 4f4debd5..65ab4b4c 100644 --- a/docs/en/gun/1.2/guide/index.html +++ b/docs/en/gun/1.2/guide/index.html @@ -117,6 +117,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/introduction/index.html b/docs/en/gun/1.2/guide/introduction/index.html index 9d4e23f8..c3d849be 100644 --- a/docs/en/gun/1.2/guide/introduction/index.html +++ b/docs/en/gun/1.2/guide/introduction/index.html @@ -143,6 +143,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/migrating_from_1.0/index.html b/docs/en/gun/1.2/guide/migrating_from_1.0/index.html index 6a644772..78862e65 100644 --- a/docs/en/gun/1.2/guide/migrating_from_1.0/index.html +++ b/docs/en/gun/1.2/guide/migrating_from_1.0/index.html @@ -128,6 +128,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/migrating_from_1.1/index.html b/docs/en/gun/1.2/guide/migrating_from_1.1/index.html index 180030e2..19c78506 100644 --- a/docs/en/gun/1.2/guide/migrating_from_1.1/index.html +++ b/docs/en/gun/1.2/guide/migrating_from_1.1/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/protocols/index.html b/docs/en/gun/1.2/guide/protocols/index.html index 396115ed..f0afae03 100644 --- a/docs/en/gun/1.2/guide/protocols/index.html +++ b/docs/en/gun/1.2/guide/protocols/index.html @@ -270,6 +270,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/start/index.html b/docs/en/gun/1.2/guide/start/index.html index 052889d0..2f447961 100644 --- a/docs/en/gun/1.2/guide/start/index.html +++ b/docs/en/gun/1.2/guide/start/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/guide/websocket/index.html b/docs/en/gun/1.2/guide/websocket/index.html index c240be1c..faa9c21f 100644 --- a/docs/en/gun/1.2/guide/websocket/index.html +++ b/docs/en/gun/1.2/guide/websocket/index.html @@ -200,6 +200,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.await/index.html b/docs/en/gun/1.2/manual/gun.await/index.html index 49ac8ff1..25e94bf1 100644 --- a/docs/en/gun/1.2/manual/gun.await/index.html +++ b/docs/en/gun/1.2/manual/gun.await/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.await_body/index.html b/docs/en/gun/1.2/manual/gun.await_body/index.html index c46d06e0..c1dc0829 100644 --- a/docs/en/gun/1.2/manual/gun.await_body/index.html +++ b/docs/en/gun/1.2/manual/gun.await_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.await_up/index.html b/docs/en/gun/1.2/manual/gun.await_up/index.html index 6c5f2d49..daec2fc4 100644 --- a/docs/en/gun/1.2/manual/gun.await_up/index.html +++ b/docs/en/gun/1.2/manual/gun.await_up/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.cancel/index.html b/docs/en/gun/1.2/manual/gun.cancel/index.html index 723fd59d..8c5f2031 100644 --- a/docs/en/gun/1.2/manual/gun.cancel/index.html +++ b/docs/en/gun/1.2/manual/gun.cancel/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.close/index.html b/docs/en/gun/1.2/manual/gun.close/index.html index 0bc1a938..40e314b1 100644 --- a/docs/en/gun/1.2/manual/gun.close/index.html +++ b/docs/en/gun/1.2/manual/gun.close/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.connect/index.html b/docs/en/gun/1.2/manual/gun.connect/index.html index c3d91d76..ad3594a1 100644 --- a/docs/en/gun/1.2/manual/gun.connect/index.html +++ b/docs/en/gun/1.2/manual/gun.connect/index.html @@ -191,6 +191,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.data/index.html b/docs/en/gun/1.2/manual/gun.data/index.html index a5187e39..a7c65314 100644 --- a/docs/en/gun/1.2/manual/gun.data/index.html +++ b/docs/en/gun/1.2/manual/gun.data/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.delete/index.html b/docs/en/gun/1.2/manual/gun.delete/index.html index f994b92b..b1492f9c 100644 --- a/docs/en/gun/1.2/manual/gun.delete/index.html +++ b/docs/en/gun/1.2/manual/gun.delete/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.flush/index.html b/docs/en/gun/1.2/manual/gun.flush/index.html index 96c51461..f9d4fc6d 100644 --- a/docs/en/gun/1.2/manual/gun.flush/index.html +++ b/docs/en/gun/1.2/manual/gun.flush/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.get/index.html b/docs/en/gun/1.2/manual/gun.get/index.html index 37203947..7f45b986 100644 --- a/docs/en/gun/1.2/manual/gun.get/index.html +++ b/docs/en/gun/1.2/manual/gun.get/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.head/index.html b/docs/en/gun/1.2/manual/gun.head/index.html index 30a3dd71..86085f1e 100644 --- a/docs/en/gun/1.2/manual/gun.head/index.html +++ b/docs/en/gun/1.2/manual/gun.head/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.info/index.html b/docs/en/gun/1.2/manual/gun.info/index.html index f275d597..7b113943 100644 --- a/docs/en/gun/1.2/manual/gun.info/index.html +++ b/docs/en/gun/1.2/manual/gun.info/index.html @@ -134,6 +134,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.open/index.html b/docs/en/gun/1.2/manual/gun.open/index.html index 0da0808a..3d529407 100644 --- a/docs/en/gun/1.2/manual/gun.open/index.html +++ b/docs/en/gun/1.2/manual/gun.open/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.open_unix/index.html b/docs/en/gun/1.2/manual/gun.open_unix/index.html index d862beed..953b127f 100644 --- a/docs/en/gun/1.2/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.2/manual/gun.open_unix/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.options/index.html b/docs/en/gun/1.2/manual/gun.options/index.html index 972c5d08..1f88938b 100644 --- a/docs/en/gun/1.2/manual/gun.options/index.html +++ b/docs/en/gun/1.2/manual/gun.options/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.patch/index.html b/docs/en/gun/1.2/manual/gun.patch/index.html index 6ec60738..1b435b3f 100644 --- a/docs/en/gun/1.2/manual/gun.patch/index.html +++ b/docs/en/gun/1.2/manual/gun.patch/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.post/index.html b/docs/en/gun/1.2/manual/gun.post/index.html index b3365c42..2d3ce187 100644 --- a/docs/en/gun/1.2/manual/gun.post/index.html +++ b/docs/en/gun/1.2/manual/gun.post/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.put/index.html b/docs/en/gun/1.2/manual/gun.put/index.html index 169394e8..08974e6b 100644 --- a/docs/en/gun/1.2/manual/gun.put/index.html +++ b/docs/en/gun/1.2/manual/gun.put/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.request/index.html b/docs/en/gun/1.2/manual/gun.request/index.html index d50af260..d89ff0c1 100644 --- a/docs/en/gun/1.2/manual/gun.request/index.html +++ b/docs/en/gun/1.2/manual/gun.request/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.ws_send/index.html b/docs/en/gun/1.2/manual/gun.ws_send/index.html index f7678c14..198b5765 100644 --- a/docs/en/gun/1.2/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.2/manual/gun.ws_send/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html index f07b4c5f..1da38236 100644 --- a/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.2/manual/gun.ws_upgrade/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun/index.html b/docs/en/gun/1.2/manual/gun/index.html index d4630a9a..d7fea7b7 100644 --- a/docs/en/gun/1.2/manual/gun/index.html +++ b/docs/en/gun/1.2/manual/gun/index.html @@ -357,6 +357,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_app/index.html b/docs/en/gun/1.2/manual/gun_app/index.html index 478479c2..691b87b4 100644 --- a/docs/en/gun/1.2/manual/gun_app/index.html +++ b/docs/en/gun/1.2/manual/gun_app/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_data/index.html b/docs/en/gun/1.2/manual/gun_data/index.html index ca194ace..d582ed44 100644 --- a/docs/en/gun/1.2/manual/gun_data/index.html +++ b/docs/en/gun/1.2/manual/gun_data/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_down/index.html b/docs/en/gun/1.2/manual/gun_down/index.html index 3afbf006..30316336 100644 --- a/docs/en/gun/1.2/manual/gun_down/index.html +++ b/docs/en/gun/1.2/manual/gun_down/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_error/index.html b/docs/en/gun/1.2/manual/gun_error/index.html index dae0f3e2..d809c267 100644 --- a/docs/en/gun/1.2/manual/gun_error/index.html +++ b/docs/en/gun/1.2/manual/gun_error/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_inform/index.html b/docs/en/gun/1.2/manual/gun_inform/index.html index b6463dd3..4e2bcd8f 100644 --- a/docs/en/gun/1.2/manual/gun_inform/index.html +++ b/docs/en/gun/1.2/manual/gun_inform/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_push/index.html b/docs/en/gun/1.2/manual/gun_push/index.html index 84cd82fc..b0db9619 100644 --- a/docs/en/gun/1.2/manual/gun_push/index.html +++ b/docs/en/gun/1.2/manual/gun_push/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_response/index.html b/docs/en/gun/1.2/manual/gun_response/index.html index 8f89df89..c655c918 100644 --- a/docs/en/gun/1.2/manual/gun_response/index.html +++ b/docs/en/gun/1.2/manual/gun_response/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_trailers/index.html b/docs/en/gun/1.2/manual/gun_trailers/index.html index a9ee058b..d02e74f9 100644 --- a/docs/en/gun/1.2/manual/gun_trailers/index.html +++ b/docs/en/gun/1.2/manual/gun_trailers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_up/index.html b/docs/en/gun/1.2/manual/gun_up/index.html index e292d769..988d588f 100644 --- a/docs/en/gun/1.2/manual/gun_up/index.html +++ b/docs/en/gun/1.2/manual/gun_up/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_upgrade/index.html b/docs/en/gun/1.2/manual/gun_upgrade/index.html index b69ff0de..109621ef 100644 --- a/docs/en/gun/1.2/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.2/manual/gun_upgrade/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/gun_ws/index.html b/docs/en/gun/1.2/manual/gun_ws/index.html index 1294bfaa..b5d8e849 100644 --- a/docs/en/gun/1.2/manual/gun_ws/index.html +++ b/docs/en/gun/1.2/manual/gun_ws/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.2/manual/index.html b/docs/en/gun/1.2/manual/index.html index dbac41ce..232c514e 100644 --- a/docs/en/gun/1.2/manual/index.html +++ b/docs/en/gun/1.2/manual/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/connect/index.html b/docs/en/gun/1.3/guide/connect/index.html index f0d83ba0..576cafb7 100644 --- a/docs/en/gun/1.3/guide/connect/index.html +++ b/docs/en/gun/1.3/guide/connect/index.html @@ -216,6 +216,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/http/index.html b/docs/en/gun/1.3/guide/http/index.html index 986c1ecb..0b49a3f1 100644 --- a/docs/en/gun/1.3/guide/http/index.html +++ b/docs/en/gun/1.3/guide/http/index.html @@ -391,6 +391,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/index.html b/docs/en/gun/1.3/guide/index.html index b915bae5..e5e0f372 100644 --- a/docs/en/gun/1.3/guide/index.html +++ b/docs/en/gun/1.3/guide/index.html @@ -119,6 +119,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/introduction/index.html b/docs/en/gun/1.3/guide/introduction/index.html index 5fc019cc..5f738ad0 100644 --- a/docs/en/gun/1.3/guide/introduction/index.html +++ b/docs/en/gun/1.3/guide/introduction/index.html @@ -143,6 +143,8 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/migrating_from_1.0/index.html b/docs/en/gun/1.3/guide/migrating_from_1.0/index.html index 08b5b595..d84aea7c 100644 --- a/docs/en/gun/1.3/guide/migrating_from_1.0/index.html +++ b/docs/en/gun/1.3/guide/migrating_from_1.0/index.html @@ -128,6 +128,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/migrating_from_1.1/index.html b/docs/en/gun/1.3/guide/migrating_from_1.1/index.html index 29252b79..33e8308a 100644 --- a/docs/en/gun/1.3/guide/migrating_from_1.1/index.html +++ b/docs/en/gun/1.3/guide/migrating_from_1.1/index.html @@ -134,6 +134,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/migrating_from_1.2/index.html b/docs/en/gun/1.3/guide/migrating_from_1.2/index.html index e305e121..90d11248 100644 --- a/docs/en/gun/1.3/guide/migrating_from_1.2/index.html +++ b/docs/en/gun/1.3/guide/migrating_from_1.2/index.html @@ -144,6 +144,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/protocols/index.html b/docs/en/gun/1.3/guide/protocols/index.html index d31253fc..aef51b3b 100644 --- a/docs/en/gun/1.3/guide/protocols/index.html +++ b/docs/en/gun/1.3/guide/protocols/index.html @@ -270,6 +270,8 @@ + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/start/index.html b/docs/en/gun/1.3/guide/start/index.html index b59a5c82..deabae16 100644 --- a/docs/en/gun/1.3/guide/start/index.html +++ b/docs/en/gun/1.3/guide/start/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/guide/websocket/index.html b/docs/en/gun/1.3/guide/websocket/index.html index 0f5599c3..c258df84 100644 --- a/docs/en/gun/1.3/guide/websocket/index.html +++ b/docs/en/gun/1.3/guide/websocket/index.html @@ -210,6 +210,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.await/index.html b/docs/en/gun/1.3/manual/gun.await/index.html index f0de8ffd..30c748ff 100644 --- a/docs/en/gun/1.3/manual/gun.await/index.html +++ b/docs/en/gun/1.3/manual/gun.await/index.html @@ -184,6 +184,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.await_body/index.html b/docs/en/gun/1.3/manual/gun.await_body/index.html index d84ffb61..0c683eca 100644 --- a/docs/en/gun/1.3/manual/gun.await_body/index.html +++ b/docs/en/gun/1.3/manual/gun.await_body/index.html @@ -160,6 +160,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.await_up/index.html b/docs/en/gun/1.3/manual/gun.await_up/index.html index aa335c36..1e9f6cc5 100644 --- a/docs/en/gun/1.3/manual/gun.await_up/index.html +++ b/docs/en/gun/1.3/manual/gun.await_up/index.html @@ -152,6 +152,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.cancel/index.html b/docs/en/gun/1.3/manual/gun.cancel/index.html index 47fa582e..d36f6819 100644 --- a/docs/en/gun/1.3/manual/gun.cancel/index.html +++ b/docs/en/gun/1.3/manual/gun.cancel/index.html @@ -138,6 +138,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.close/index.html b/docs/en/gun/1.3/manual/gun.close/index.html index df5523c3..41d017d4 100644 --- a/docs/en/gun/1.3/manual/gun.close/index.html +++ b/docs/en/gun/1.3/manual/gun.close/index.html @@ -130,6 +130,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.connect/index.html b/docs/en/gun/1.3/manual/gun.connect/index.html index 80258210..5df95f76 100644 --- a/docs/en/gun/1.3/manual/gun.connect/index.html +++ b/docs/en/gun/1.3/manual/gun.connect/index.html @@ -191,6 +191,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.data/index.html b/docs/en/gun/1.3/manual/gun.data/index.html index 0f32b54e..4977ccfb 100644 --- a/docs/en/gun/1.3/manual/gun.data/index.html +++ b/docs/en/gun/1.3/manual/gun.data/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.delete/index.html b/docs/en/gun/1.3/manual/gun.delete/index.html index e074833c..54422a6d 100644 --- a/docs/en/gun/1.3/manual/gun.delete/index.html +++ b/docs/en/gun/1.3/manual/gun.delete/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.flush/index.html b/docs/en/gun/1.3/manual/gun.flush/index.html index 2ce795c6..9cd73195 100644 --- a/docs/en/gun/1.3/manual/gun.flush/index.html +++ b/docs/en/gun/1.3/manual/gun.flush/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.get/index.html b/docs/en/gun/1.3/manual/gun.get/index.html index da22c1ff..0060291f 100644 --- a/docs/en/gun/1.3/manual/gun.get/index.html +++ b/docs/en/gun/1.3/manual/gun.get/index.html @@ -161,6 +161,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.head/index.html b/docs/en/gun/1.3/manual/gun.head/index.html index 3ca16b11..3871e048 100644 --- a/docs/en/gun/1.3/manual/gun.head/index.html +++ b/docs/en/gun/1.3/manual/gun.head/index.html @@ -163,6 +163,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.info/index.html b/docs/en/gun/1.3/manual/gun.info/index.html index 05d8dbdc..facf23b5 100644 --- a/docs/en/gun/1.3/manual/gun.info/index.html +++ b/docs/en/gun/1.3/manual/gun.info/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.open/index.html b/docs/en/gun/1.3/manual/gun.open/index.html index b1d02a8d..17d95644 100644 --- a/docs/en/gun/1.3/manual/gun.open/index.html +++ b/docs/en/gun/1.3/manual/gun.open/index.html @@ -154,6 +154,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.open_unix/index.html b/docs/en/gun/1.3/manual/gun.open_unix/index.html index cbba6a00..b8999723 100644 --- a/docs/en/gun/1.3/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.3/manual/gun.open_unix/index.html @@ -142,6 +142,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.options/index.html b/docs/en/gun/1.3/manual/gun.options/index.html index 2a0ce0df..f62da2c0 100644 --- a/docs/en/gun/1.3/manual/gun.options/index.html +++ b/docs/en/gun/1.3/manual/gun.options/index.html @@ -158,6 +158,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.patch/index.html b/docs/en/gun/1.3/manual/gun.patch/index.html index 2f3aa847..3c83ffd7 100644 --- a/docs/en/gun/1.3/manual/gun.patch/index.html +++ b/docs/en/gun/1.3/manual/gun.patch/index.html @@ -181,6 +181,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.post/index.html b/docs/en/gun/1.3/manual/gun.post/index.html index c566697b..b1ae8888 100644 --- a/docs/en/gun/1.3/manual/gun.post/index.html +++ b/docs/en/gun/1.3/manual/gun.post/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.put/index.html b/docs/en/gun/1.3/manual/gun.put/index.html index 3fc5d7c9..9504f2a0 100644 --- a/docs/en/gun/1.3/manual/gun.put/index.html +++ b/docs/en/gun/1.3/manual/gun.put/index.html @@ -179,6 +179,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.request/index.html b/docs/en/gun/1.3/manual/gun.request/index.html index 11d3238e..d718f07a 100644 --- a/docs/en/gun/1.3/manual/gun.request/index.html +++ b/docs/en/gun/1.3/manual/gun.request/index.html @@ -165,6 +165,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.ws_send/index.html b/docs/en/gun/1.3/manual/gun.ws_send/index.html index a744b54a..658c9045 100644 --- a/docs/en/gun/1.3/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.3/manual/gun.ws_send/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html index a39d8171..4452a8e2 100644 --- a/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html @@ -171,6 +171,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun/index.html b/docs/en/gun/1.3/manual/gun/index.html index 20f2a82d..8abc280a 100644 --- a/docs/en/gun/1.3/manual/gun/index.html +++ b/docs/en/gun/1.3/manual/gun/index.html @@ -363,6 +363,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_app/index.html b/docs/en/gun/1.3/manual/gun_app/index.html index 8d12f7ba..06c9858a 100644 --- a/docs/en/gun/1.3/manual/gun_app/index.html +++ b/docs/en/gun/1.3/manual/gun_app/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_data/index.html b/docs/en/gun/1.3/manual/gun_data/index.html index 8f55d91b..15ebea6d 100644 --- a/docs/en/gun/1.3/manual/gun_data/index.html +++ b/docs/en/gun/1.3/manual/gun_data/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_down/index.html b/docs/en/gun/1.3/manual/gun_down/index.html index de3d145a..e27840a8 100644 --- a/docs/en/gun/1.3/manual/gun_down/index.html +++ b/docs/en/gun/1.3/manual/gun_down/index.html @@ -153,6 +153,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_error/index.html b/docs/en/gun/1.3/manual/gun_error/index.html index 278fd2de..d4e74ff1 100644 --- a/docs/en/gun/1.3/manual/gun_error/index.html +++ b/docs/en/gun/1.3/manual/gun_error/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_inform/index.html b/docs/en/gun/1.3/manual/gun_inform/index.html index e0685f5a..f69219c4 100644 --- a/docs/en/gun/1.3/manual/gun_inform/index.html +++ b/docs/en/gun/1.3/manual/gun_inform/index.html @@ -146,6 +146,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_push/index.html b/docs/en/gun/1.3/manual/gun_push/index.html index 76268627..3398fa51 100644 --- a/docs/en/gun/1.3/manual/gun_push/index.html +++ b/docs/en/gun/1.3/manual/gun_push/index.html @@ -166,6 +166,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_response/index.html b/docs/en/gun/1.3/manual/gun_response/index.html index 43ceaf11..23acd08b 100644 --- a/docs/en/gun/1.3/manual/gun_response/index.html +++ b/docs/en/gun/1.3/manual/gun_response/index.html @@ -149,6 +149,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_trailers/index.html b/docs/en/gun/1.3/manual/gun_trailers/index.html index 63062282..82dc8fca 100644 --- a/docs/en/gun/1.3/manual/gun_trailers/index.html +++ b/docs/en/gun/1.3/manual/gun_trailers/index.html @@ -141,6 +141,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_up/index.html b/docs/en/gun/1.3/manual/gun_up/index.html index 35bf7753..7b95810a 100644 --- a/docs/en/gun/1.3/manual/gun_up/index.html +++ b/docs/en/gun/1.3/manual/gun_up/index.html @@ -137,6 +137,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_upgrade/index.html b/docs/en/gun/1.3/manual/gun_upgrade/index.html index 3229a0d8..886b8cfa 100644 --- a/docs/en/gun/1.3/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.3/manual/gun_upgrade/index.html @@ -147,6 +147,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/gun_ws/index.html b/docs/en/gun/1.3/manual/gun_ws/index.html index 018e8ec9..9ab1b2bc 100644 --- a/docs/en/gun/1.3/manual/gun_ws/index.html +++ b/docs/en/gun/1.3/manual/gun_ws/index.html @@ -143,6 +143,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/1.3/manual/index.html b/docs/en/gun/1.3/manual/index.html index 3d2f9b21..187eeba4 100644 --- a/docs/en/gun/1.3/manual/index.html +++ b/docs/en/gun/1.3/manual/index.html @@ -123,6 +123,8 @@ http://www.gnu.org/software/src-highlite --> + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> diff --git a/docs/en/gun/2.0/guide/connect.asciidoc b/docs/en/gun/2.0/guide/connect.asciidoc new file mode 100644 index 00000000..08f8db29 --- /dev/null +++ b/docs/en/gun/2.0/guide/connect.asciidoc @@ -0,0 +1,166 @@ +[[connect]] +== Connection + +This chapter describes how to open, monitor and close +a connection using the Gun client. + +=== Gun connections + +Gun is designed with the HTTP/2 and Websocket protocols in mind. +They are built for long-running connections that allow concurrent +exchange of data, either in the form of request/responses for +HTTP/2 or in the form of messages for Websocket. + +A Gun connection is an Erlang process that manages a socket to +a remote endpoint. This Gun connection is owned by a user +process that is called the _owner_ of the connection, and is +managed by the supervision tree of the `gun` application. + +Any process can communicate with the Gun connection +by calling functions from the module `gun`. All functions +perform their respective operations asynchronously. The Gun +connection will send Erlang messages to the calling process +whenever needed. + +When the remote endpoint closes the connection, Gun attempts +to reconnect automatically. + +=== Opening a new connection + +The `gun:open/2,3` function must be used to open a connection. + +.Opening a connection to example.org on port 443 +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 443). +---- + +If the port given is 443, Gun will attempt to connect using +TLS. The protocol will be selected automatically using the +ALPN extension for TLS. By default Gun supports HTTP/2 +and HTTP/1.1 when connecting using TLS. + +For any other port, Gun will attempt to connect using +plain TCP and will use the HTTP/1.1 protocol. + +The transport and protocol used can be overriden via +options. The manual documents all available options. + +Options can be provided as a third argument, and take the +form of a map. + +.Opening a TLS connection to example.org on port 8443 +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 8443, #{transport => tls}). +---- + +When using TLS you may want to tweak the +http://erlang.org/doc/man/ssl_app.html#configuration[configuration] +for the `ssl` application, in particular the `session_lifetime` +and `session_cache_client_max` to limit the amount of memory +used for the TLS sessions cache. + +=== Waiting for the connection to be established + +When Gun successfully connects to the server, it sends a +`gun_up` message with the protocol that has been selected +for the connection. + +Gun provides the functions `gun:await_up/1,2,3` that wait +for the `gun_up` message. They can optionally take a monitor +reference and/or timeout value. If no monitor is provided, +one will be created for the duration of the function call. + +.Synchronous opening of a connection +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 443), +{ok, Protocol} = gun:await_up(ConnPid). +---- + +=== Handling connection loss + +When the connection is lost, Gun will send a `gun_down` +message indicating the current protocol, the reason the +connection was lost and two lists of stream references. + +The first list indicates open streams that _may_ have been +processed by the server. The second list indicates open +streams that the server did not process. + +=== Monitoring the connection process + +Because software errors are unavoidable, it is important to +detect when the Gun process crashes. It is also important +to detect when it exits normally. Erlang provides two ways +to do that: links and monitors. + +Gun leaves you the choice as to which one will be used. +However, if you use the `gun:await/2,3` or `gun:await_body/2,3` +functions, a monitor may be used for you to avoid getting +stuck waiting for a message that will never come. + +If you choose to monitor yourself you can do it on a permanent +basis rather than on every message you will receive, saving +resources. Indeed, the `gun:await/3,4` and `gun:await_body/3,4` +functions both accept a monitor argument if you have one already. + +.Monitoring the connection process +[source,erlang] +---- +{ok, ConnPid} = gun:open("example.org", 443). +MRef = monitor(process, ConnPid). +---- + +This monitor reference can be kept and used until the connection +process exits. + +.Handling `DOWN` messages +[source,erlang] +---- +receive + %% Receive Gun messages here... + {'DOWN', Mref, process, ConnPid, Reason} -> + error_logger:error_msg("Oops!"), + exit(Reason) +end. +---- + +What to do when you receive a `DOWN` message is entirely up to you. + +=== Closing the connection abruptly + +The connection can be stopped abruptly at any time by calling +the `gun:close/1` function. + +.Immediate closing of the connection +[source,erlang] +---- +gun:close(ConnPid). +---- + +The process is stopped immediately without having a chance to +perform the protocol's closing handshake, if any. + +//=== Closing the connection gracefully +// +//The connection can also be stopped gracefully by calling the +//`gun:shutdown/1` function. +// +//.Graceful shutdown of the connection +//[source,erlang] +//---- +//gun:shutdown(ConnPid). +//---- +// +//Gun will refuse any new requests or messages after you call +//this function. It will however continue to send you messages +//for existing streams until they are all completed. +// +//For example if you performed a GET request just before calling +//`gun:shutdown/1`, you will still receive the response before +//Gun closes the connection. +// +//If you set a monitor beforehand, you will receive a message +//when the connection has been closed. diff --git a/docs/en/gun/2.0/guide/connect/index.html b/docs/en/gun/2.0/guide/connect/index.html new file mode 100644 index 00000000..06000bf7 --- /dev/null +++ b/docs/en/gun/2.0/guide/connect/index.html @@ -0,0 +1,277 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Connection</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Connection</span></h1> + +<p>This chapter describes how to open, monitor and close a connection using the Gun client.</p> +<h2 id="_gun_connections">Gun connections</h2> +<p>Gun is designed with the HTTP/2 and Websocket protocols in mind. They are built for long-running connections that allow concurrent exchange of data, either in the form of request/responses for HTTP/2 or in the form of messages for Websocket.</p> +<p>A Gun connection is an Erlang process that manages a socket to a remote endpoint. This Gun connection is owned by a user process that is called the <em>owner</em> of the connection, and is managed by the supervision tree of the <code>gun</code> application.</p> +<p>Any process can communicate with the Gun connection by calling functions from the module <code>gun</code>. All functions perform their respective operations asynchronously. The Gun connection will send Erlang messages to the calling process whenever needed.</p> +<p>When the remote endpoint closes the connection, Gun attempts to reconnect automatically.</p> +<h2 id="_opening_a_new_connection">Opening a new connection</h2> +<p>The <code>gun:open/2,3</code> function must be used to open a connection.</p> +<div class="listingblock"><div class="title">Opening a connection to example.org on port 443</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If the port given is 443, Gun will attempt to connect using TLS. The protocol will be selected automatically using the ALPN extension for TLS. By default Gun supports HTTP/2 and HTTP/1.1 when connecting using TLS.</p> +<p>For any other port, Gun will attempt to connect using plain TCP and will use the HTTP/1.1 protocol.</p> +<p>The transport and protocol used can be overriden via options. The manual documents all available options.</p> +<p>Options can be provided as a third argument, and take the form of a map.</p> +<div class="listingblock"><div class="title">Opening a TLS connection to example.org on port 8443</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">8443</font>, #{<font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tls</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<p>When using TLS you may want to tweak the <a href="http://erlang.org/doc/man/ssl_app.html#configuration">configuration</a> for the <code>ssl</code> application, in particular the <code>session_lifetime</code> and <code>session_cache_client_max</code> to limit the amount of memory used for the TLS sessions cache.</p> +<h2 id="_waiting_for_the_connection_to_be_established">Waiting for the connection to be established</h2> +<p>When Gun successfully connects to the server, it sends a <code>gun_up</code> message with the protocol that has been selected for the connection.</p> +<p>Gun provides the functions <code>gun:await_up/1,2,3</code> that wait for the <code>gun_up</code> message. They can optionally take a monitor reference and/or timeout value. If no monitor is provided, one will be created for the duration of the function call.</p> +<div class="listingblock"><div class="title">Synchronous opening of a connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>), +{<font color="#FF6600">ok</font>, <font color="#009900">Protocol</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_handling_connection_loss">Handling connection loss</h2> +<p>When the connection is lost, Gun will send a <code>gun_down</code> message indicating the current protocol, the reason the connection was lost and two lists of stream references.</p> +<p>The first list indicates open streams that <em>may</em> have been processed by the server. The second list indicates open streams that the server did not process.</p> +<h2 id="_monitoring_the_connection_process">Monitoring the connection process</h2> +<p>Because software errors are unavoidable, it is important to detect when the Gun process crashes. It is also important to detect when it exits normally. Erlang provides two ways to do that: links and monitors.</p> +<p>Gun leaves you the choice as to which one will be used. However, if you use the <code>gun:await/2,3</code> or <code>gun:await_body/2,3</code> functions, a monitor may be used for you to avoid getting stuck waiting for a message that will never come.</p> +<p>If you choose to monitor yourself you can do it on a permanent basis rather than on every message you will receive, saving resources. Indeed, the <code>gun:await/3,4</code> and <code>gun:await_body/3,4</code> functions both accept a monitor argument if you have one already.</p> +<div class="listingblock"><div class="title">Monitoring the connection process</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font> +<font color="#009900">MRef</font> <font color="#990000">=</font> <b><font color="#000000">monitor</font></b>(<b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>This monitor reference can be kept and used until the connection process exits.</p> +<div class="listingblock"><div class="title">Handling `DOWN` messages</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + <i><font color="#9A1900">%% Receive Gun messages here...</font></i> + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">Mref</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>What to do when you receive a <code>DOWN</code> message is entirely up to you.</p> +<h2 id="_closing_the_connection_abruptly">Closing the connection abruptly</h2> +<p>The connection can be stopped abruptly at any time by calling the <code>gun:close/1</code> function.</p> +<div class="listingblock"><div class="title">Immediate closing of the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:close</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The process is stopped immediately without having a chance to perform the protocol's closing handshake, if any.</p> +<!-- === Closing the connection gracefully--> +<!-- --> +<!-- The connection can also be stopped gracefully by calling the--> +<!-- `gun:shutdown/1` function.--> +<!-- --> +<!-- .Graceful shutdown of the connection--> +<!-- [source,erlang]--> +<!-- ------> +<!-- gun:shutdown(ConnPid).--> +<!-- ------> +<!-- --> +<!-- Gun will refuse any new requests or messages after you call--> +<!-- this function. It will however continue to send you messages--> +<!-- for existing streams until they are all completed.--> +<!-- --> +<!-- For example if you performed a GET request just before calling--> +<!-- `gun:shutdown/1`, you will still receive the response before--> +<!-- Gun closes the connection.--> +<!-- --> +<!-- If you set a monitor beforehand, you will receive a message--> +<!-- when the connection has been closed.--> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/protocols/"> + Supported protocols + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/http/"> + HTTP + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/gun.sty b/docs/en/gun/2.0/guide/gun.sty new file mode 100644 index 00000000..d5e0d3be --- /dev/null +++ b/docs/en/gun/2.0/guide/gun.sty @@ -0,0 +1,8 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{asciidoc-dblatex}[2012/10/24 AsciiDoc DocBook Style] + +%% Just use the original package and pass the options. +\RequirePackageWithOptions{docbook} + +%% Define an alias for make snippets to be compatible with source-highlighter. +\lstalias{makefile}{make} diff --git a/docs/en/gun/2.0/guide/http.asciidoc b/docs/en/gun/2.0/guide/http.asciidoc new file mode 100644 index 00000000..51cb994f --- /dev/null +++ b/docs/en/gun/2.0/guide/http.asciidoc @@ -0,0 +1,387 @@ +[[http]] +== HTTP + +This chapter describes how to use the Gun client for +communicating with an HTTP/1.1 or HTTP/2 server. + +=== Streams + +Every time a request is initiated, Gun creates a _stream_. +A _stream reference_ uniquely identifies a set of request and +response and must be used to perform additional operations +with a stream or to identify its messages. + +Stream references use the Erlang _reference_ data type and +are therefore unique. + +Streams can be canceled at any time. This will stop any further +messages from being sent to the calling process. Depending on +its capabilities, the server will also be instructed to cancel +the request. + +Canceling a stream may result in Gun dropping the connection +temporarily, to avoid uploading or downloading data that will +not be used. + +.Cancelling a stream +[source,erlang] +---- +gun:cancel(ConnPid, StreamRef). +---- + +=== Sending requests + +Gun provides many convenient functions for performing common +operations, like GET, POST or DELETE. It also provides a +general purpose function in case you need other methods. + +The availability of these methods on the server can vary +depending on the software used but also on a per-resource +basis. + +Gun will automatically set a few headers depending on the +method used. For all methods however it will set the host +header if it has not been provided in the request arguments. + +This section focuses on the act of sending a request. The +handling of responses will be explained further on. + +==== GET and HEAD + +Use `gun:get/2,3,4` to request a resource. + +.GET "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/organizations/ninenines"). +---- + +.GET "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/organizations/ninenines", [ + {<<"accept">>, "application/json"}, + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +Note that the list of headers has the field name as a binary. +The field value is iodata, which is either a binary or an +iolist. + +Use `gun:head/2,3,4` if you don't need the response body. + +.HEAD "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:head(ConnPid, "/organizations/ninenines"). +---- + +.HEAD "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:head(ConnPid, "/organizations/ninenines", [ + {<<"accept">>, "application/json"}, + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +It is not possible to send a request body with a GET or HEAD +request. + +==== POST, PUT and PATCH + +HTTP defines three methods to create or update a resource. + +POST is generally used when the resource identifier (URI) isn't known +in advance when creating a resource. POST can also be used to +replace an existing resource, although PUT is more appropriate +in that situation. + +PUT creates or replaces a resource identified by the URI. + +PATCH provides instructions on how to modify the resource. + +Both POST and PUT send the entire resource representation in their +request body. The PATCH method can be used when this is not +desirable. The request body of a PATCH method may be a partial +representation or a list of instructions on how to update the +resource. + +The functions `gun:post/4,5`, `gun:put/4,5` and `gun:patch/4,5` +take a body as their fourth argument. These functions do +not require any body-specific header to be set, although +it is always recommended to set the content-type header. +Gun will set the other headers automatically. + +In this and the following examples in this section, `gun:post` +can be replaced by `gun:put` or `gun:patch` for performing +a PUT or PATCH request, respectively. + +.POST "/organizations/ninenines" +[source,erlang] +---- +Body = "{\"msg\": \"Hello world!\"}", +StreamRef = gun:post(ConnPid, "/organizations/ninenines", [ + {<<"content-type">>, "application/json"} +], Body). +---- + +The functions `gun:post/3,4`, `gun:put/3,4` and `gun:patch/3,4` +do not take a body in their arguments: the body must be +provided later on using the `gun:data/4` function. + +It is recommended to send the content-length header if you +know it in advance, although this is not required. If it +is not set, HTTP/1.1 will use the chunked transfer-encoding, +and HTTP/2 will continue normally as it is chunked by design. + +.POST "/organizations/ninenines" with delayed body +[source,erlang] +---- +Body = "{\"msg\": \"Hello world!\"}", +StreamRef = gun:post(ConnPid, "/organizations/ninenines", [ + {<<"content-length">>, integer_to_binary(length(Body))}, + {<<"content-type">>, "application/json"} +]), +gun:data(ConnPid, StreamRef, fin, Body). +---- + +The atom `fin` indicates this is the last chunk of data to +be sent. You can call the `gun:data/4` function as many +times as needed until you have sent the entire body. The +last call must use `fin` and all the previous calls must +use `nofin`. The last chunk may be empty. + +.Streaming the request body +[source,erlang] +---- +sendfile(ConnPid, StreamRef, Filepath) -> + {ok, IoDevice} = file:open(Filepath, [read, binary, raw]), + do_sendfile(ConnPid, StreamRef, IoDevice). + +do_sendfile(ConnPid, StreamRef, IoDevice) -> + case file:read(IoDevice, 8000) of + eof -> + gun:data(ConnPid, StreamRef, fin, <<>>), + file:close(IoDevice); + {ok, Bin} -> + gun:data(ConnPid, StreamRef, nofin, Bin), + do_sendfile(ConnPid, StreamRef, IoDevice) + end. +---- + +==== DELETE + +Use `gun:delete/2,3,4` to delete a resource. + +.DELETE "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:delete(ConnPid, "/organizations/ninenines"). +---- + +.DELETE "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:delete(ConnPid, "/organizations/ninenines", [ + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +==== OPTIONS + +Use `gun:options/2,3` to request information about a resource. + +.OPTIONS "/organizations/ninenines" +[source,erlang] +---- +StreamRef = gun:options(ConnPid, "/organizations/ninenines"). +---- + +.OPTIONS "/organizations/ninenines" with custom headers +[source,erlang] +---- +StreamRef = gun:options(ConnPid, "/organizations/ninenines", [ + {<<"user-agent">>, "revolver/1.0"} +]). +---- + +You can also use this function to request information about +the server itself. + +.OPTIONS "*" +[source,erlang] +---- +StreamRef = gun:options(ConnPid, "*"). +---- + +==== Requests with an arbitrary method + +The functions `gun:headers/4,5` or `gun:request/5,6` can be +used to send requests with a configurable method name. It is +mostly useful when you need a method that Gun does not +understand natively. + +.Example of a TRACE request +[source,erlang] +---- +gun:request(ConnPid, "TRACE", "/", [ + {<<"max-forwards">>, "30"} +], <<>>). +---- + +=== Processing responses + +All data received from the server is sent to the calling +process as a message. First a `gun_response` message is sent, +followed by zero or more `gun_data` messages. If something goes wrong, +a `gun_error` message is sent instead. + +The response message will inform you whether there will be +data messages following. If it contains `fin` there will be +no data messages. If it contains `nofin` then one or more data +messages will follow. + +When using HTTP/2 this value is sent with the frame and simply +passed on in the message. When using HTTP/1.1 however Gun must +guess whether data will follow by looking at the response headers. + +You can receive messages directly, or you can use the _await_ +functions to let Gun receive them for you. + +.Receiving a response using receive +[source,erlang] +---- +print_body(ConnPid, MRef) -> + StreamRef = gun:get(ConnPid, "/"), + receive + {gun_response, ConnPid, StreamRef, fin, Status, Headers} -> + no_data; + {gun_response, ConnPid, StreamRef, nofin, Status, Headers} -> + receive_data(ConnPid, MRef, StreamRef); + {'DOWN', MRef, process, ConnPid, Reason} -> + error_logger:error_msg("Oops!"), + exit(Reason) + after 1000 -> + exit(timeout) + end. + +receive_data(ConnPid, MRef, StreamRef) -> + receive + {gun_data, ConnPid, StreamRef, nofin, Data} -> + io:format("~s~n", [Data]), + receive_data(ConnPid, MRef, StreamRef); + {gun_data, ConnPid, StreamRef, fin, Data} -> + io:format("~s~n", [Data]); + {'DOWN', MRef, process, ConnPid, Reason} -> + error_logger:error_msg("Oops!"), + exit(Reason) + after 1000 -> + exit(timeout) + end. +---- + +While it may seem verbose, using messages like this has the +advantage of never locking your process, allowing you to +easily debug your code. It also allows you to start more than +one connection and concurrently perform queries on all of them +at the same time. + +You can also use Gun in a synchronous manner by using the _await_ +functions. + +The `gun:await/2,3,4` function will wait until it receives +a response to, a pushed resource related to, or data from +the given stream. + +When calling `gun:await/2,3` and not passing a monitor +reference, one is automatically created for you for the +duration of the call. + +The `gun:await_body/2,3,4` works similarly, but returns the +body received. Both functions can be combined to receive the +response and its body sequentially. + +.Receiving a response using await +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/"), +case gun:await(ConnPid, StreamRef) of + {response, fin, Status, Headers} -> + no_data; + {response, nofin, Status, Headers} -> + {ok, Body} = gun:await_body(ConnPid, StreamRef), + io:format("~s~n", [Body]) +end. +---- + +=== Handling streams pushed by the server + +The HTTP/2 protocol allows the server to push more than one +resource for every request. It will start sending those +extra resources before it starts sending the response itself, +so Gun will send you `gun_push` messages before `gun_response` +when that happens. + +You can safely choose to ignore `gun_push` messages, or +you can handle them. If you do, you can either receive the +messages directly or use _await_ functions. + +The `gun_push` message contains both the new stream reference +and the stream reference of the original request. + +.Receiving a pushed response using receive +[source,erlang] +---- +receive + {gun_push, ConnPid, OriginalStreamRef, PushedStreamRef, + Method, Host, Path, Headers} -> + enjoy() +end. +---- + +If you use the `gun:await/2,3,4` function, however, Gun +will use the original reference to identify the message but +will return a tuple that doesn't contain it. + +.Receiving a pushed response using await +[source,erlang] +---- +{push, PushedStreamRef, Method, URI, Headers} + = gun:await(ConnPid, OriginalStreamRef). +---- + +The `PushedStreamRef` variable can then be used with `gun:await/2,3,4` +and `gun:await_body/2,3,4`. + +=== Flushing unwanted messages + +Gun provides the function `gun:flush/1` to quickly get rid +of unwanted messages sitting in the process mailbox. You +can use it to get rid of all messages related to a connection, +or just the messages related to a stream. + +.Flush all messages from a Gun connection +[source,erlang] +---- +gun:flush(ConnPid). +---- + +.Flush all messages from a specific stream +[source,erlang] +---- +gun:flush(StreamRef). +---- + +=== Redirecting responses to a different process + +Gun allows you to specify which process will handle responses +to a request via the `reply_to` request option. + +.GET "/organizations/ninenines" to a different process +[source,erlang] +---- +StreamRef = gun:get(ConnPid, "/organizations/ninenines", [], + #{reply_to => Pid}). +---- diff --git a/docs/en/gun/2.0/guide/http/index.html b/docs/en/gun/2.0/guide/http/index.html new file mode 100644 index 00000000..47b346ac --- /dev/null +++ b/docs/en/gun/2.0/guide/http/index.html @@ -0,0 +1,451 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: HTTP</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>HTTP</span></h1> + +<p>This chapter describes how to use the Gun client for communicating with an HTTP/1.1 or HTTP/2 server.</p> +<h2 id="_streams">Streams</h2> +<p>Every time a request is initiated, Gun creates a <em>stream</em>. A <em>stream reference</em> uniquely identifies a set of request and response and must be used to perform additional operations with a stream or to identify its messages.</p> +<p>Stream references use the Erlang <em>reference</em> data type and are therefore unique.</p> +<p>Streams can be canceled at any time. This will stop any further messages from being sent to the calling process. Depending on its capabilities, the server will also be instructed to cancel the request.</p> +<p>Canceling a stream may result in Gun dropping the connection temporarily, to avoid uploading or downloading data that will not be used.</p> +<div class="listingblock"><div class="title">Cancelling a stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_sending_requests">Sending requests</h2> +<p>Gun provides many convenient functions for performing common operations, like GET, POST or DELETE. It also provides a general purpose function in case you need other methods.</p> +<p>The availability of these methods on the server can vary depending on the software used but also on a per-resource basis.</p> +<p>Gun will automatically set a few headers depending on the method used. For all methods however it will set the host header if it has not been provided in the request arguments.</p> +<p>This section focuses on the act of sending a request. The handling of responses will be explained further on.</p> +<h4 id="_get_and_head">GET and HEAD</h4> +<p>Use <code>gun:get/2,3,4</code> to request a resource.</p> +<div class="listingblock"><div class="title">GET "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">GET "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>}, + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that the list of headers has the field name as a binary. The field value is iodata, which is either a binary or an iolist.</p> +<p>Use <code>gun:head/2,3,4</code> if you don't need the response body.</p> +<div class="listingblock"><div class="title">HEAD "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">HEAD "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>}, + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>It is not possible to send a request body with a GET or HEAD request.</p> +<h4 id="_post__put_and_patch">POST, PUT and PATCH</h4> +<p>HTTP defines three methods to create or update a resource.</p> +<p>POST is generally used when the resource identifier (URI) isn't known in advance when creating a resource. POST can also be used to replace an existing resource, although PUT is more appropriate in that situation.</p> +<p>PUT creates or replaces a resource identified by the URI.</p> +<p>PATCH provides instructions on how to modify the resource.</p> +<p>Both POST and PUT send the entire resource representation in their request body. The PATCH method can be used when this is not desirable. The request body of a PATCH method may be a partial representation or a list of instructions on how to update the resource.</p> +<p>The functions <code>gun:post/4,5</code>, <code>gun:put/4,5</code> and <code>gun:patch/4,5</code> take a body as their fourth argument. These functions do not require any body-specific header to be set, although it is always recommended to set the content-type header. Gun will set the other headers automatically.</p> +<p>In this and the following examples in this section, <code>gun:post</code> can be replaced by <code>gun:put</code> or <code>gun:patch</code> for performing a PUT or PATCH request, respectively.</p> +<div class="listingblock"><div class="title">POST "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Body</font> <font color="#990000">=</font> <font color="#FF0000">"{\"msg\": \"Hello world!\"}"</font>, +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>} +], <font color="#009900">Body</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The functions <code>gun:post/3,4</code>, <code>gun:put/3,4</code> and <code>gun:patch/3,4</code> do not take a body in their arguments: the body must be provided later on using the <code>gun:data/4</code> function.</p> +<p>It is recommended to send the content-length header if you know it in advance, although this is not required. If it is not set, HTTP/1.1 will use the chunked transfer-encoding, and HTTP/2 will continue normally as it is chunked by design.</p> +<div class="listingblock"><div class="title">POST "/organizations/ninenines" with delayed body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Body</font> <font color="#990000">=</font> <font color="#FF0000">"{\"msg\": \"Hello world!\"}"</font>, +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-length"</font><font color="#990000">>></font>, <b><font color="#000000">integer_to_binary</font></b>(<b><font color="#000080">length</font></b>(<font color="#009900">Body</font>))}, + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>} +]), +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Body</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The atom <code>fin</code> indicates this is the last chunk of data to be sent. You can call the <code>gun:data/4</code> function as many times as needed until you have sent the entire body. The last call must use <code>fin</code> and all the previous calls must use <code>nofin</code>. The last chunk may be empty.</p> +<div class="listingblock"><div class="title">Streaming the request body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Filepath</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">IoDevice</font>} <font color="#990000">=</font> <b><font color="#000000">file:open</font></b>(<font color="#009900">Filepath</font>, [<font color="#FF6600">read</font>, <b><font color="#000080">binary</font></b>, <font color="#FF6600">raw</font>]), + <b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>)<font color="#990000">.</font> + +<b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">file:read</font></b>(<font color="#009900">IoDevice</font>, <font color="#993399">8000</font>) <b><font color="#0000FF">of</font></b> + <font color="#FF6600">eof</font> <font color="#990000">-></font> + <b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<>></font>), + <b><font color="#000000">file:close</font></b>(<font color="#009900">IoDevice</font>); + {<font color="#FF6600">ok</font>, <font color="#009900">Bin</font>} <font color="#990000">-></font> + <b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Bin</font>), + <b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h4 id="_delete">DELETE</h4> +<p>Use <code>gun:delete/2,3,4</code> to delete a resource.</p> +<div class="listingblock"><div class="title">DELETE "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">DELETE "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<h4 id="_options">OPTIONS</h4> +<p>Use <code>gun:options/2,3</code> to request information about a resource.</p> +<div class="listingblock"><div class="title">OPTIONS "/organizations/ninenines"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">OPTIONS "/organizations/ninenines" with custom headers</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can also use this function to request information about the server itself.</p> +<div class="listingblock"><div class="title">OPTIONS "*"</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"*"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h4 id="_requests_with_an_arbitrary_method">Requests with an arbitrary method</h4> +<p>The functions <code>gun:headers/4,5</code> or <code>gun:request/5,6</code> can be used to send requests with a configurable method name. It is mostly useful when you need a method that Gun does not understand natively.</p> +<div class="listingblock"><div class="title">Example of a TRACE request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:request</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"TRACE"</font>, <font color="#FF0000">"/"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"max-forwards"</font><font color="#990000">>></font>, <font color="#FF0000">"30"</font>} +], <font color="#990000"><<>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_processing_responses">Processing responses</h2> +<p>All data received from the server is sent to the calling process as a message. First a <code>gun_response</code> message is sent, followed by zero or more <code>gun_data</code> messages. If something goes wrong, a <code>gun_error</code> message is sent instead.</p> +<p>The response message will inform you whether there will be data messages following. If it contains <code>fin</code> there will be no data messages. If it contains <code>nofin</code> then one or more data messages will follow.</p> +<p>When using HTTP/2 this value is sent with the frame and simply passed on in the message. When using HTTP/1.1 however Gun must guess whether data will follow by looking at the response headers.</p> +<p>You can receive messages directly, or you can use the <em>await</em> functions to let Gun receive them for you.</p> +<div class="listingblock"><div class="title">Receiving a response using receive</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">print_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>) <font color="#990000">-></font> + <font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/"</font>), + <b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <font color="#FF6600">no_data</font>; + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">MRef</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) + <b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font> + +<b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> + <b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Data</font>]), + <b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Data</font>]); + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">MRef</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) + <b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>While it may seem verbose, using messages like this has the advantage of never locking your process, allowing you to easily debug your code. It also allows you to start more than one connection and concurrently perform queries on all of them at the same time.</p> +<p>You can also use Gun in a synchronous manner by using the <em>await</em> functions.</p> +<p>The <code>gun:await/2,3,4</code> function will wait until it receives a response to, a pushed resource related to, or data from the given stream.</p> +<p>When calling <code>gun:await/2,3</code> and not passing a monitor reference, one is automatically created for you for the duration of the call.</p> +<p>The <code>gun:await_body/2,3,4</code> works similarly, but returns the body received. Both functions can be combined to receive the response and its body sequentially.</p> +<div class="listingblock"><div class="title">Receiving a response using await</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/"</font>), +<b><font color="#0000FF">case</font></b> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <font color="#FF6600">no_data</font>; + {<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Body</font>]) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_handling_streams_pushed_by_the_server">Handling streams pushed by the server</h2> +<p>The HTTP/2 protocol allows the server to push more than one resource for every request. It will start sending those extra resources before it starts sending the response itself, so Gun will send you <code>gun_push</code> messages before <code>gun_response</code> when that happens.</p> +<p>You can safely choose to ignore <code>gun_push</code> messages, or you can handle them. If you do, you can either receive the messages directly or use <em>await</em> functions.</p> +<p>The <code>gun_push</code> message contains both the new stream reference and the stream reference of the original request.</p> +<div class="listingblock"><div class="title">Receiving a pushed response using receive</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">OriginalStreamRef</font>, <font color="#009900">PushedStreamRef</font>, + <font color="#009900">Method</font>, <font color="#009900">Host</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">enjoy</font></b>() +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>If you use the <code>gun:await/2,3,4</code> function, however, Gun will use the original reference to identify the message but will return a tuple that doesn't contain it.</p> +<div class="listingblock"><div class="title">Receiving a pushed response using await</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">push</font>, <font color="#009900">PushedStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">OriginalStreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The <code>PushedStreamRef</code> variable can then be used with <code>gun:await/2,3,4</code> and <code>gun:await_body/2,3,4</code>.</p> +<h2 id="_flushing_unwanted_messages">Flushing unwanted messages</h2> +<p>Gun provides the function <code>gun:flush/1</code> to quickly get rid of unwanted messages sitting in the process mailbox. You can use it to get rid of all messages related to a connection, or just the messages related to a stream.</p> +<div class="listingblock"><div class="title">Flush all messages from a Gun connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Flush all messages from a specific stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_redirecting_responses_to_a_different_process">Redirecting responses to a different process</h2> +<p>Gun allows you to specify which process will handle responses to a request via the <code>reply_to</code> request option.</p> +<div class="listingblock"><div class="title">GET "/organizations/ninenines" to a different process</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [], + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">Pid</font>})<font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/connect/"> + Connection + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/websocket/"> + Websocket + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/index.html b/docs/en/gun/2.0/guide/index.html new file mode 100644 index 00000000..fd0ce5f9 --- /dev/null +++ b/docs/en/gun/2.0/guide/index.html @@ -0,0 +1,179 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Gun User Guide</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Gun User Guide</span></h1> + +<h2 id="_interface">Interface</h2> +<ul><li><a href="introduction/">Introduction</a> +</li> +<li><a href="start/">Starting and stopping</a> +</li> +<li><a href="protocols/">Supported protocols</a> +</li> +<li><a href="connect/">Connection</a> +</li> +<li><a href="http/">Using HTTP</a> +</li> +<li><a href="websocket/">Using Websocket</a> +</li> +</ul> +<h2 id="_additional_information">Additional information</h2> +<ul><li><a href="migrating_from_1.2/">Migrating from Gun 1.2 to 1.3</a> +</li> +<li><a href="migrating_from_1.1/">Migrating from Gun 1.1 to 1.2</a> +</li> +<li><a href="migrating_from_1.0/">Migrating from Gun 1.0 to 1.1</a> +</li> +</ul> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/introduction.asciidoc b/docs/en/gun/2.0/guide/introduction.asciidoc new file mode 100644 index 00000000..dfbe1e30 --- /dev/null +++ b/docs/en/gun/2.0/guide/introduction.asciidoc @@ -0,0 +1,55 @@ +[[introduction]] +== Introduction + +Gun is an HTTP client for Erlang/OTP. + +Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols. + +=== Prerequisites + +Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket +protocols is required in order to read this guide. + +=== Supported platforms + +Gun is tested and supported on Linux, FreeBSD, Windows and OSX. + +Gun is developed for Erlang/OTP 20.0 and newer. + +Note that Gun will not work on the Windows build of Erlang/OTP 20.3 +due to a bug in Erlang/OTP's stdlib application. The ticket number +for this bug is OTP-13995 and it was fixed in the patch release +OTP-20.3.2. Replacing the `gen_statem.beam` file on an 20.3 +installation is enough to fix the issue. + +=== License + +Gun uses the ISC License. + +---- +Copyright (c) 2013-2019, Loïc Hoguin <[email protected]> + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +---- + +=== Versioning + +Gun uses http://semver.org/[Semantic Versioning 2.0.0]. + +=== Conventions + +In the HTTP protocol, the method name is case sensitive. All standard +method names are uppercase. + +Header names are case insensitive. Gun converts all the header names +to lowercase, including request headers provided by your application. diff --git a/docs/en/gun/2.0/guide/introduction/index.html b/docs/en/gun/2.0/guide/introduction/index.html new file mode 100644 index 00000000..51ffc006 --- /dev/null +++ b/docs/en/gun/2.0/guide/introduction/index.html @@ -0,0 +1,203 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Introduction</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Introduction</span></h1> + +<p>Gun is an HTTP client for Erlang/OTP.</p> +<p>Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols.</p> +<h2 id="_prerequisites">Prerequisites</h2> +<p>Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket protocols is required in order to read this guide.</p> +<h2 id="_supported_platforms">Supported platforms</h2> +<p>Gun is tested and supported on Linux, FreeBSD, Windows and OSX.</p> +<p>Gun is developed for Erlang/OTP 20.0 and newer.</p> +<p>Note that Gun will not work on the Windows build of Erlang/OTP 20.3 due to a bug in Erlang/OTP's stdlib application. The ticket number for this bug is OTP-13995 and it was fixed in the patch release OTP-20.3.2. Replacing the <code>gen_statem.beam</code> file on an 20.3 installation is enough to fix the issue.</p> +<h2 id="_license">License</h2> +<p>Gun uses the ISC License.</p> +<div class="listingblock"><div class="content"><pre>Copyright (c) 2013-2019, Loïc Hoguin <[email protected]> + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> +<h2 id="_versioning">Versioning</h2> +<p>Gun uses <a href="http://semver.org/">Semantic Versioning 2.0.0</a>.</p> +<h2 id="_conventions">Conventions</h2> +<p>In the HTTP protocol, the method name is case sensitive. All standard method names are uppercase.</p> +<p>Header names are case insensitive. Gun converts all the header names to lowercase, including request headers provided by your application.</p> + + + + + + + + + + + + <nav style="margin:1em 0"> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/start/"> + Starting and stopping + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/migrating_from_1.0.asciidoc b/docs/en/gun/2.0/guide/migrating_from_1.0.asciidoc new file mode 100644 index 00000000..8057683c --- /dev/null +++ b/docs/en/gun/2.0/guide/migrating_from_1.0.asciidoc @@ -0,0 +1,21 @@ +[appendix] +== Migrating from Gun 1.0 to 1.1 + +Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a +few problems with experimental features. + +== Features added + +* Update Cowlib to 2.5.1 + +=== Bugs fixed + +* A bug in the experimental `gun_sse_h` where lone id lines + were not propagated has been fixed by updating the Cowlib + dependency. + +* The status code was incorrectly given to the experimental + content handlers as a binary. It has been fixed an an + integer is now given as was intended. + +* A number of Dialyzer warnings have been fixed. diff --git a/docs/en/gun/2.0/guide/migrating_from_1.0/index.html b/docs/en/gun/2.0/guide/migrating_from_1.0/index.html new file mode 100644 index 00000000..d6705cf3 --- /dev/null +++ b/docs/en/gun/2.0/guide/migrating_from_1.0/index.html @@ -0,0 +1,188 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Gun 1.0 to 1.1</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Gun 1.0 to 1.1</span></h1> + +<p>Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a few problems with experimental features.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>Update Cowlib to 2.5.1 +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>A bug in the experimental <code>gun_sse_h</code> where lone id lines were not propagated has been fixed by updating the Cowlib dependency. +</li> +<li>The status code was incorrectly given to the experimental content handlers as a binary. It has been fixed an an integer is now given as was intended. +</li> +<li>A number of Dialyzer warnings have been fixed. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.1/"> + Migrating from Gun 1.1 to 1.2 + </a> + + + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/migrating_from_1.1.asciidoc b/docs/en/gun/2.0/guide/migrating_from_1.1.asciidoc new file mode 100644 index 00000000..bc2097f9 --- /dev/null +++ b/docs/en/gun/2.0/guide/migrating_from_1.1.asciidoc @@ -0,0 +1,28 @@ +[appendix] +== Migrating from Gun 1.1 to 1.2 + +Gun 1.2 adds support for the CONNECT request over HTTP/1.1 +connections. + +== Features added + +* CONNECT requests can now be issued on HTTP/1.1 connections. + The tunneled connection can use any of the protocols Gun + supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and + TLS transports. Note that Gun currently does not support + tunneling a TLS connection over a TLS connection due to + limitations in Erlang/OTP. + +* Gun supports sending multiple CONNECT requests, allowing + the tunnel to the origin server to go through multiple + proxies. + +* Gun supports sending CONNECT requests with authorization + credentials using the Basic authentication mechanism. + +* Update Cowlib to 2.6.0 + +== Functions added + +* The functions `gun:connect/2,3,4` have been added. They can + be used to initiate CONNECT requests on HTTP/1.1 connections. diff --git a/docs/en/gun/2.0/guide/migrating_from_1.1/index.html b/docs/en/gun/2.0/guide/migrating_from_1.1/index.html new file mode 100644 index 00000000..5deb48c4 --- /dev/null +++ b/docs/en/gun/2.0/guide/migrating_from_1.1/index.html @@ -0,0 +1,194 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Gun 1.1 to 1.2</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Gun 1.1 to 1.2</span></h1> + +<p>Gun 1.2 adds support for the CONNECT request over HTTP/1.1 connections.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>CONNECT requests can now be issued on HTTP/1.1 connections. The tunneled connection can use any of the protocols Gun supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and TLS transports. Note that Gun currently does not support tunneling a TLS connection over a TLS connection due to limitations in Erlang/OTP. +</li> +<li>Gun supports sending multiple CONNECT requests, allowing the tunnel to the origin server to go through multiple proxies. +</li> +<li>Gun supports sending CONNECT requests with authorization credentials using the Basic authentication mechanism. +</li> +<li>Update Cowlib to 2.6.0 +</li> +</ul> +<h2 id="_functions_added">Functions added</h2> +<ul><li>The functions <code>gun:connect/2,3,4</code> have been added. They can be used to initiate CONNECT requests on HTTP/1.1 connections. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.2/"> + Migrating from Gun 1.2 to 1.3 + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.0/"> + Migrating from Gun 1.0 to 1.1 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/migrating_from_1.2.asciidoc b/docs/en/gun/2.0/guide/migrating_from_1.2.asciidoc new file mode 100644 index 00000000..a870858e --- /dev/null +++ b/docs/en/gun/2.0/guide/migrating_from_1.2.asciidoc @@ -0,0 +1,39 @@ +[appendix] +== Migrating from Gun 1.2 to 1.3 + +Gun 1.3 improves the support for CONNECT requests +introduced in the previous version and documents +Websocket protocol negotiation. + +== Features added + +* The `protocols` CONNECT destination option has been added + as a replacement for the now deprecated `protocol` option. + +* Add built-in support for Websocket protocol negotiation + through the Websocket option `protocols`. The interface + of the handler module currently remains undocumented and + must be set to `gun_ws_h`. + +* Add the h2specd HTTP/2 test suite from the h2spec project. + +=== Bugs fixed + +* Fix connecting to HTTP/2 over TLS origin servers via + HTTP/1.1 CONNECT proxies. + +* Do not send the HTTP/1.1 keepalive while waiting for + a response to a CONNECT request. + +* Do not crash on HTTP/2 HEADERS frames with the + PRIORITY flag set. + +* Do not crash on HTTP/2 HEADERS frames when the + END_HEADERS flag is not set. + +* Do not crash on unknown HTTP/2 frame types. + +* Reject HTTP/2 WINDOW_UPDATE frames when they would + cause the window to overflow. + +* Send a GOAWAY frame on closing the HTTP/2 connection. diff --git a/docs/en/gun/2.0/guide/migrating_from_1.2/index.html b/docs/en/gun/2.0/guide/migrating_from_1.2/index.html new file mode 100644 index 00000000..bb2d6436 --- /dev/null +++ b/docs/en/gun/2.0/guide/migrating_from_1.2/index.html @@ -0,0 +1,204 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Migrating from Gun 1.2 to 1.3</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Migrating from Gun 1.2 to 1.3</span></h1> + +<p>Gun 1.3 improves the support for CONNECT requests introduced in the previous version and documents Websocket protocol negotiation.</p> +<h2 id="_features_added">Features added</h2> +<ul><li>The <code>protocols</code> CONNECT destination option has been added as a replacement for the now deprecated <code>protocol</code> option. +</li> +<li>Add built-in support for Websocket protocol negotiation through the Websocket option <code>protocols</code>. The interface of the handler module currently remains undocumented and must be set to <code>gun_ws_h</code>. +</li> +<li>Add the h2specd HTTP/2 test suite from the h2spec project. +</li> +</ul> +<h2 id="_bugs_fixed">Bugs fixed</h2> +<ul><li>Fix connecting to HTTP/2 over TLS origin servers via HTTP/1.1 CONNECT proxies. +</li> +<li>Do not send the HTTP/1.1 keepalive while waiting for a response to a CONNECT request. +</li> +<li>Do not crash on HTTP/2 HEADERS frames with the PRIORITY flag set. +</li> +<li>Do not crash on HTTP/2 HEADERS frames when the END_HEADERS flag is not set. +</li> +<li>Do not crash on unknown HTTP/2 frame types. +</li> +<li>Reject HTTP/2 WINDOW_UPDATE frames when they would cause the window to overflow. +</li> +<li>Send a GOAWAY frame on closing the HTTP/2 connection. +</li> +</ul> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/websocket/"> + Websocket + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.1/"> + Migrating from Gun 1.1 to 1.2 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/protocols.asciidoc b/docs/en/gun/2.0/guide/protocols.asciidoc new file mode 100644 index 00000000..d2529e38 --- /dev/null +++ b/docs/en/gun/2.0/guide/protocols.asciidoc @@ -0,0 +1,127 @@ +[[protocols]] +== Supported protocols + +This chapter describes the protocols supported and the +operations available to them. + +=== HTTP/1.1 + +HTTP/1.1 is a text request-response protocol. The client +sends a request, the server sends back a response. + +Gun provides convenience functions for performing GET, HEAD, +OPTIONS, POST, PATCH, PUT, and DELETE requests. All these +functions are aliases of `gun:headers/4,5` or `gun:request/5,6` +for the respective methods. Gun also provides a `gun:data/4` +function for streaming the request body. + +Gun will send a `gun_inform` message for every intermediate +informational responses received. They will always be sent +before the `gun_response` message. + +Gun will send a `gun_response` message for every response +received, followed by zero or more `gun_data` messages for +the response body, which is optionally terminated by a +`gun_trailers` message. If something goes wrong, a `gun_error` +will be sent instead. + +Gun provides convenience functions for dealing with messages. +The `gun:await/2,3,4` function waits for a response to the given +request, and the `gun:await_body/2,3,4` function for the +response body. The `gun:flush/1` function can be used to clear all +messages related to a request or a connection from the mailbox +of the calling process. + +The function `gun:cancel/2` can be used to silence the +response to a request previously sent if it is no longer +needed. When using HTTP/1.1 there is no multiplexing so +Gun will have to receive the response fully before any +other responses can be received. + +Finally, Gun can upgrade an HTTP/1.1 connection to Websocket. +It provides the `gun:ws_upgrade/2,3,4` function for that +purpose. A `gun_upgrade` message will be sent on success; +a `gun_response` message otherwise. + +=== HTTP/2 + +HTTP/2 is a binary protocol based on HTTP, compatible with +the HTTP semantics, that reduces the complexity of parsing +requests and responses, compresses the HTTP headers and +allows the server to push additional resources along with +the normal response to the original request. + +The HTTP/2 interface is very similar to HTTP/1.1, so this +section instead focuses on the differences in the interface +for the two protocols. + +Gun will send `gun_push` messages for every push received. +They will always be sent before the `gun_response` message. +They can be ignored safely if they are not needed, or they +can be canceled. + +The `gun:cancel/2` function will use the HTTP/2 stream +cancellation mechanism which allows Gun to inform the +server to stop sending a response for this particular +request, saving resources. + +It is not currently possible to upgrade an HTTP/2 connection +to Websocket. Support for this will be added in a future +release. + +=== Websocket + +Websocket is a binary protocol built on top of HTTP that +allows asynchronous concurrent communication between the +client and the server. A Websocket server can push data to +the client at any time. + +Websocket is only available as a connection upgrade over +an HTTP/1.1 connection. + +Once the Websocket connection is established, the only +operation available on this connection is sending Websocket +frames using `gun:ws_send/2`. + +Gun will send a `gun_ws` message for every frame received. + +=== Summary + +The two following tables summarize the supported operations +and the messages Gun sends depending on the connection's +current protocol. + +.Supported operations per protocol +[cols="<,3*^",options="header"] +|=== +| Operation | HTTP/1.1 | HTTP/2 | Websocket +| delete | yes | yes | no +| get | yes | yes | no +| head | yes | yes | no +| options | yes | yes | no +| patch | yes | yes | no +| post | yes | yes | no +| put | yes | yes | no +| request | yes | yes | no +| data | yes | yes | no +| await | yes | yes | no +| await_body | yes | yes | no +| flush | yes | yes | no +| cancel | yes | yes | no +| ws_upgrade | yes | no | no +| ws_send | no | no | yes +|=== + +.Messages sent per protocol +[cols="<,3*^",options="header"] +|=== +| Message | HTTP/1.1 | HTTP/2 | Websocket +| gun_push | no | yes | no +| gun_inform | yes | yes | no +| gun_response | yes | yes | no +| gun_data | yes | yes | no +| gun_trailers | yes | yes | no +| gun_error | yes | yes | yes +| gun_upgrade | yes | no | no +| gun_ws | no | no | yes +|=== diff --git a/docs/en/gun/2.0/guide/protocols/index.html b/docs/en/gun/2.0/guide/protocols/index.html new file mode 100644 index 00000000..aa9c08cb --- /dev/null +++ b/docs/en/gun/2.0/guide/protocols/index.html @@ -0,0 +1,330 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Supported protocols</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Supported protocols</span></h1> + +<p>This chapter describes the protocols supported and the operations available to them.</p> +<h2 id="_http_1_1">HTTP/1.1</h2> +<p>HTTP/1.1 is a text request-response protocol. The client sends a request, the server sends back a response.</p> +<p>Gun provides convenience functions for performing GET, HEAD, OPTIONS, POST, PATCH, PUT, and DELETE requests. All these functions are aliases of <code>gun:headers/4,5</code> or <code>gun:request/5,6</code> for the respective methods. Gun also provides a <code>gun:data/4</code> function for streaming the request body.</p> +<p>Gun will send a <code>gun_inform</code> message for every intermediate informational responses received. They will always be sent before the <code>gun_response</code> message.</p> +<p>Gun will send a <code>gun_response</code> message for every response received, followed by zero or more <code>gun_data</code> messages for the response body, which is optionally terminated by a <code>gun_trailers</code> message. If something goes wrong, a <code>gun_error</code> will be sent instead.</p> +<p>Gun provides convenience functions for dealing with messages. The <code>gun:await/2,3,4</code> function waits for a response to the given request, and the <code>gun:await_body/2,3,4</code> function for the response body. The <code>gun:flush/1</code> function can be used to clear all messages related to a request or a connection from the mailbox of the calling process.</p> +<p>The function <code>gun:cancel/2</code> can be used to silence the response to a request previously sent if it is no longer needed. When using HTTP/1.1 there is no multiplexing so Gun will have to receive the response fully before any other responses can be received.</p> +<p>Finally, Gun can upgrade an HTTP/1.1 connection to Websocket. It provides the <code>gun:ws_upgrade/2,3,4</code> function for that purpose. A <code>gun_upgrade</code> message will be sent on success; a <code>gun_response</code> message otherwise.</p> +<h2 id="_http_2">HTTP/2</h2> +<p>HTTP/2 is a binary protocol based on HTTP, compatible with the HTTP semantics, that reduces the complexity of parsing requests and responses, compresses the HTTP headers and allows the server to push additional resources along with the normal response to the original request.</p> +<p>The HTTP/2 interface is very similar to HTTP/1.1, so this section instead focuses on the differences in the interface for the two protocols.</p> +<p>Gun will send <code>gun_push</code> messages for every push received. They will always be sent before the <code>gun_response</code> message. They can be ignored safely if they are not needed, or they can be canceled.</p> +<p>The <code>gun:cancel/2</code> function will use the HTTP/2 stream cancellation mechanism which allows Gun to inform the server to stop sending a response for this particular request, saving resources.</p> +<p>It is not currently possible to upgrade an HTTP/2 connection to Websocket. Support for this will be added in a future release.</p> +<h2 id="_websocket">Websocket</h2> +<p>Websocket is a binary protocol built on top of HTTP that allows asynchronous concurrent communication between the client and the server. A Websocket server can push data to the client at any time.</p> +<p>Websocket is only available as a connection upgrade over an HTTP/1.1 connection.</p> +<p>Once the Websocket connection is established, the only operation available on this connection is sending Websocket frames using <code>gun:ws_send/2</code>.</p> +<p>Gun will send a <code>gun_ws</code> message for every frame received.</p> +<h2 id="_summary">Summary</h2> +<p>The two following tables summarize the supported operations and the messages Gun sends depending on the connection's current protocol.</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<caption>Supported operations per protocol</caption><thead><tr><th>Operation</th> +<th>HTTP/1.1</th> +<th>HTTP/2</th> +<th>Websocket</th> +</tr></thead><tbody><tr><td>delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>get</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>head</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>options</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>patch</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>post</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>put</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>request</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>data</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>await</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>await_body</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>flush</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>cancel</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>ws_upgrade</td> +<td>yes</td> +<td>no</td> +<td>no</td> +</tr> +<tr><td>ws_send</td> +<td>no</td> +<td>no</td> +<td>yes</td> +</tr> +</tbody></table> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<caption>Messages sent per protocol</caption><thead><tr><th>Message</th> +<th>HTTP/1.1</th> +<th>HTTP/2</th> +<th>Websocket</th> +</tr></thead><tbody><tr><td>gun_push</td> +<td>no</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_inform</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_response</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_data</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_trailers</td> +<td>yes</td> +<td>yes</td> +<td>no</td> +</tr> +<tr><td>gun_error</td> +<td>yes</td> +<td>yes</td> +<td>yes</td> +</tr> +<tr><td>gun_upgrade</td> +<td>yes</td> +<td>no</td> +<td>no</td> +</tr> +<tr><td>gun_ws</td> +<td>no</td> +<td>no</td> +<td>yes</td> +</tr> +</tbody></table> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/start/"> + Starting and stopping + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/connect/"> + Connection + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/start.asciidoc b/docs/en/gun/2.0/guide/start.asciidoc new file mode 100644 index 00000000..09720dca --- /dev/null +++ b/docs/en/gun/2.0/guide/start.asciidoc @@ -0,0 +1,43 @@ +[[start]] +== Starting and stopping + +This chapter describes how to start and stop the Gun application. + +=== Setting up + +Specify Gun as a dependency to your application in your favorite +build tool. + +With Erlang.mk this is done by adding `gun` to the `DEPS` variable +in your Makefile. + +.Adding Gun as an Erlang.mk dependency +[source,make] +---- +DEPS = gun +---- + +=== Starting + +Gun is an _OTP application_. It needs to be started before you can +use it. + +.Starting Gun in an Erlang shell +[source,erlang] +---- +1> application:ensure_all_started(gun). +{ok,[crypto,cowlib,asn1,public_key,ssl,gun]} +---- + +=== Stopping + +You can stop Gun using the `application:stop/1` function, however +only Gun will be stopped. This is the reverse of `application:start/1`. +The `application_ensure_all_started/1` function has no equivalent for +stopping all applications. + +.Stopping Gun +[source,erlang] +---- +application:stop(gun). +---- diff --git a/docs/en/gun/2.0/guide/start/index.html b/docs/en/gun/2.0/guide/start/index.html new file mode 100644 index 00000000..b1836e94 --- /dev/null +++ b/docs/en/gun/2.0/guide/start/index.html @@ -0,0 +1,209 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Starting and stopping</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Starting and stopping</span></h1> + +<p>This chapter describes how to start and stop the Gun application.</p> +<h2 id="_setting_up">Setting up</h2> +<p>Specify Gun as a dependency to your application in your favorite build tool.</p> +<p>With Erlang.mk this is done by adding <code>gun</code> to the <code>DEPS</code> variable in your Makefile.</p> +<div class="listingblock"><div class="title">Adding Gun as an Erlang.mk dependency</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">DEPS =</font> gun</tt></pre> +</div></div> +<h2 id="_starting">Starting</h2> +<p>Gun is an <em>OTP application</em>. It needs to be started before you can use it.</p> +<div class="listingblock"><div class="title">Starting Gun in an Erlang shell</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#993399">1</font><font color="#990000">></font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>,[<font color="#FF6600">crypto</font>,<font color="#FF6600">cowlib</font>,<font color="#FF6600">asn1</font>,<font color="#FF6600">public_key</font>,<font color="#FF6600">ssl</font>,<font color="#FF6600">gun</font>]}</tt></pre> +</div></div> +<h2 id="_stopping">Stopping</h2> +<p>You can stop Gun using the <code>application:stop/1</code> function, however only Gun will be stopped. This is the reverse of <code>application:start/1</code>. The <code>application_ensure_all_started/1</code> function has no equivalent for stopping all applications.</p> +<div class="listingblock"><div class="title">Stopping Gun</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">application:stop</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/introduction/"> + Introduction + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/protocols/"> + Supported protocols + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/guide/websocket.asciidoc b/docs/en/gun/2.0/guide/websocket.asciidoc new file mode 100644 index 00000000..287b3f73 --- /dev/null +++ b/docs/en/gun/2.0/guide/websocket.asciidoc @@ -0,0 +1,124 @@ +[[websocket]] +== Websocket + +This chapter describes how to use the Gun client for +communicating with a Websocket server. + +// @todo recovering from connection failure, reconnecting to Websocket etc. + +=== HTTP upgrade + +Websocket is a protocol built on top of HTTP. To use Websocket, +you must first request for the connection to be upgraded. Only +HTTP/1.1 connections can be upgraded to Websocket, so you might +need to restrict the protocol to HTTP/1.1 if you are planning +to use Websocket over TLS. + +You must use the `gun:ws_upgrade/2,3,4` function to upgrade +to Websocket. This function can be called anytime after connection, +so you can send HTTP requests before upgrading to Websocket. + +.Upgrade to Websocket +[source,erlang] +---- +gun:ws_upgrade(ConnPid, "/websocket"). +---- + +Gun will set all the necessary headers for performing the +Websocket upgrade, but you can specify additional headers +if needed. For example you can authenticate. + +.Upgrade to Websocket using HTTP authentication +[source,erlang] +---- +gun:ws_upgrade(ConnPid, "/websocket", [ + {<<"authorization">>, "Basic dXNlcm5hbWU6cGFzc3dvcmQ="} +]). +---- + +You can pass the Websocket options as part of the `gun:open/2,3` +call when opening the connection, or using the `gun:ws_upgrade/4`. +The fourth argument is those same options. + +Gun can negotiate the protocol to be used for the Websocket +connection. The `protocols` option can be given with a list +of protocols accepted and the corresponding handler module. +Note that the interface for handler modules is currently +undocumented and must be set to `gun_ws_h`. + +.Upgrade to Websocket with protocol negotiation +[source,erlang] +---- +gun:ws_upgrade(ConnPid, "/websocket", [] + #{protocols => [{<<"xmpp">>, gun_ws_h}]}). +---- + +The upgrade will fail if the server cannot satisfy the +protocol negotiation. + +When the upgrade succeeds, a `gun_upgrade` message is sent. +If the server does not understand Websocket or refused the +upgrade, a `gun_response` message is sent. If Gun couldn't +perform the upgrade due to an error (for example attempting +to upgrade to Websocket on an HTTP/1.0 connection) then a +`gun_error` message is sent. + +When the server does not understand Websocket, it may send +a meaningful response which should be processed. In the +following example we however ignore it: + +[source,erlang] +---- +receive + {gun_upgrade, ConnPid, StreamRef, [<<"websocket">>], Headers} -> + upgrade_success(ConnPid, StreamRef); + {gun_response, ConnPid, _, _, Status, Headers} -> + exit({ws_upgrade_failed, Status, Headers}); + {gun_error, ConnPid, StreamRef, Reason} -> + exit({ws_upgrade_failed, Reason}) + %% More clauses here as needed. +after 1000 -> + exit(timeout) +end. +---- + +=== Sending data + +Once the Websocket upgrade has completed successfully, you no +longer have access to functions for performing requests. You +can only send and receive Websocket messages. + +Use `gun:ws_send/2` to send messages to the server. + +.Send a text frame +[source,erlang] +---- +gun:ws_send(ConnPid, {text, "Hello!"}). +---- + +.Send a text frame, a binary frame and then close the connection +[source,erlang] +---- +gun:ws_send(ConnPid, [ + {text, "Hello!"}, + {binary, BinaryValue}, + close +]). +---- + +Note that if you send a close frame, Gun will close the connection +cleanly but may attempt to reconnect afterwards depending on the +`retry` configuration. + +=== Receiving data + +Gun sends an Erlang message to the owner process for every +Websocket message it receives. + +[source,erlang] +---- +receive + {gun_ws, ConnPid, StreamRef, Frame} -> + handle_frame(ConnPid, StreamRef, Frame) +end. +---- diff --git a/docs/en/gun/2.0/guide/websocket/index.html b/docs/en/gun/2.0/guide/websocket/index.html new file mode 100644 index 00000000..88694744 --- /dev/null +++ b/docs/en/gun/2.0/guide/websocket/index.html @@ -0,0 +1,263 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Websocket</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Websocket</span></h1> + +<p>This chapter describes how to use the Gun client for communicating with a Websocket server.</p> +<!-- @todo recovering from connection failure, reconnecting to Websocket etc.--> +<h2 id="_http_upgrade">HTTP upgrade</h2> +<p>Websocket is a protocol built on top of HTTP. To use Websocket, you must first request for the connection to be upgraded. Only HTTP/1.1 connections can be upgraded to Websocket, so you might need to restrict the protocol to HTTP/1.1 if you are planning to use Websocket over TLS.</p> +<p>You must use the <code>gun:ws_upgrade/2,3,4</code> function to upgrade to Websocket. This function can be called anytime after connection, so you can send HTTP requests before upgrading to Websocket.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Gun will set all the necessary headers for performing the Websocket upgrade, but you can specify additional headers if needed. For example you can authenticate.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket using HTTP authentication</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"authorization"</font><font color="#990000">>></font>, <font color="#FF0000">"Basic dXNlcm5hbWU6cGFzc3dvcmQ="</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can pass the Websocket options as part of the <code>gun:open/2,3</code> call when opening the connection, or using the <code>gun:ws_upgrade/4</code>. The fourth argument is those same options.</p> +<p>Gun can negotiate the protocol to be used for the Websocket connection. The <code>protocols</code> option can be given with a list of protocols accepted and the corresponding handler module. Note that the interface for handler modules is currently undocumented and must be set to <code>gun_ws_h</code>.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket with protocol negotiation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>, [] + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [{<font color="#990000"><<</font><font color="#FF0000">"xmpp"</font><font color="#990000">>></font>, <font color="#FF6600">gun_ws_h</font>}]})<font color="#990000">.</font></tt></pre> +</div></div> +<p>The upgrade will fail if the server cannot satisfy the protocol negotiation.</p> +<p>When the upgrade succeeds, a <code>gun_upgrade</code> message is sent. If the server does not understand Websocket or refused the upgrade, a <code>gun_response</code> message is sent. If Gun couldn't perform the upgrade due to an error (for example attempting to upgrade to Websocket on an HTTP/1.0 connection) then a <code>gun_error</code> message is sent.</p> +<p>When the server does not understand Websocket, it may send a meaningful response which should be processed. In the following example we however ignore it:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>], <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">upgrade_success</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#990000">_</font>, <font color="#990000">_</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>({<font color="#FF6600">ws_upgrade_failed</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>}); + {<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>({<font color="#FF6600">ws_upgrade_failed</font>, <font color="#009900">Reason</font>}) + <i><font color="#9A1900">%% More clauses here as needed.</font></i> +<b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_sending_data">Sending data</h2> +<p>Once the Websocket upgrade has completed successfully, you no longer have access to functions for performing requests. You can only send and receive Websocket messages.</p> +<p>Use <code>gun:ws_send/2</code> to send messages to the server.</p> +<div class="listingblock"><div class="title">Send a text frame</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, {<font color="#FF6600">text</font>, <font color="#FF0000">"Hello!"</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Send a text frame, a binary frame and then close the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, [ + {<font color="#FF6600">text</font>, <font color="#FF0000">"Hello!"</font>}, + {<b><font color="#000080">binary</font></b>, <font color="#009900">BinaryValue</font>}, + <font color="#FF6600">close</font> +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that if you send a close frame, Gun will close the connection cleanly but may attempt to reconnect afterwards depending on the <code>retry</code> configuration.</p> +<h2 id="_receiving_data">Receiving data</h2> +<p>Gun sends an Erlang message to the owner process for every Websocket message it receives.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>} <font color="#990000">-></font> + <b><font color="#000000">handle_frame</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> + + + + + + + + + + + + <nav style="margin:1em 0"> + + <a style="float:left" href="https://ninenines.eu/docs/en/gun/2.0/guide/http/"> + HTTP + </a> + + + + <a style="float:right" href="https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.2/"> + Migrating from Gun 1.2 to 1.3 + </a> + + </nav> + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + + User Guide +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/guide">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/guide">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/guide">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/guide">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/guide">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.await/index.html b/docs/en/gun/2.0/manual/gun.await/index.html new file mode 100644 index 00000000..2a51b063 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.await/index.html @@ -0,0 +1,255 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:await(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:await(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:await - Wait for a response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <font color="#009900">Result</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">tuple</font></b>() <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font></tt></pre> +</div></div> +<p>Wait for a response.</p> +<p>This function waits for a message from the given stream and returns it as a tuple. An error will be returned should the process fail or a relevant message is not received within the specified duration.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Timeout</dt> +<dd><p>How long to wait for a message, in milliseconds.</p> +</dd> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A number of different tuples can be returned. They correspond to the message of the same name and they contain the same elements minus the pid and stream reference. Error tuples may also be returned when a timeout or an error occur.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Result</font> <font color="#990000">::</font> {<font color="#FF6600">inform</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">response</font>, <font color="#009900">IsFin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">data</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>} + | {<font color="#FF6600">trailers</font>, <font color="#009900">Trailers</font>} + | {<font color="#FF6600">push</font>, <font color="#009900">NewStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">upgrade</font>, <font color="#009900">Protocols</font>, <font color="#009900">Headers</font>} + | {<font color="#FF6600">ws</font>, <font color="#009900">Frame</font>} + | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">stream_error</font> | <font color="#FF6600">connection_error</font> | <font color="#FF6600">down</font>, <b><font color="#000000">any</font></b>()} + | <font color="#FF6600">timeout</font></tt></pre> +</div></div> +<p>Because the messages and returned tuples are equivalent, please refer to the manual pages for each message for further information:</p> +<ul><li><a href="../gun_inform">gun_inform(3)</a> - Informational response +</li> +<li><a href="../gun_response">gun_response(3)</a> - Response +</li> +<li><a href="../gun_data">gun_data(3)</a> - Response body +</li> +<li><a href="../gun_trailers">gun_trailers(3)</a> - Response trailers +</li> +<li><a href="../gun_push">gun_push(3)</a> - Server-initiated push +</li> +<li><a href="../gun_upgrade">gun_upgrade(3)</a> - Successful protocol upgrade +</li> +<li><a href="../gun_ws">gun_ws(3)</a> - Websocket frame +</li> +</ul> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: <code>upgrade</code> and <code>ws</code> tuples can now be returned. +</li> +<li><strong>2.0</strong>: The error tuple type now includes the type of error. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Wait for a response</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +{<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#993399">200</font>, <font color="#009900">_Headers</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font> +{<font color="#FF6600">data</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.await_body/index.html b/docs/en/gun/2.0/manual/gun.await_body/index.html new file mode 100644 index 00000000..c1085e6e --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.await_body/index.html @@ -0,0 +1,223 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:await_body(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:await_body(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:await_body - Wait for the complete response body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>} | {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Trailers</font>} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Trailers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}] +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">stream_error</font> | <font color="#FF6600">connection_error</font> | <font color="#FF6600">down</font>, <b><font color="#000000">any</font></b>()} + | <font color="#FF6600">timeout</font></tt></pre> +</div></div> +<p>Wait for the complete response body.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Timeout</dt> +<dd><p>How long to wait for each message, in milliseconds.</p> +</dd> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The body is returned, possibly with trailers if the request contained a <code>te: trailers</code> header. Error tuples may also be returned when a timeout or an error occur.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The error tuple type now includes the type of error. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Wait for the complete response body</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +{<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#993399">200</font>, <font color="#009900">_Headers</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>, <font color="#009900">_Body</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await">gun:await(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.await_up/index.html b/docs/en/gun/2.0/manual/gun.await_up/index.html new file mode 100644 index 00000000..3b951709 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.await_up/index.html @@ -0,0 +1,214 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:await_up(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:await_up(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:await_up - Wait for the connection to be up</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Protocol</font>} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">down</font>, <b><font color="#000000">any</font></b>()} | <font color="#FF6600">timeout</font></tt></pre> +</div></div> +<p>Wait for the connection to be up.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Timeout</dt> +<dd><p>How long to wait for, in milliseconds.</p> +</dd> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The protocol selected for this connection. It can be used to determine the capabilities of the server. Error tuples may also be returned when a timeout or an error occur.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The error tuple type now includes the type of error. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Wait for the connection to be up</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun_socks_up">gun_socks_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.cancel/index.html b/docs/en/gun/2.0/manual/gun.cancel/index.html new file mode 100644 index 00000000..7f9f10ea --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.cancel/index.html @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:cancel(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:cancel(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:cancel - Cancel the given stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Cancel the given stream.</p> +<p>The behavior of this function depends on the protocol selected.</p> +<p>HTTP/1.1 does not support this feature. Gun will simply silence the stream and stop relaying messages. Gun may also decide to close the connection if the response body is too large, to avoid wasting time and bandwidth.</p> +<p>HTTP/2 allows cancelling streams at any time.</p> +<p>This function is asynchronous. Messages related to this stream may still be sent after the function returns.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Cancel a stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.stream_info">gun:stream_info(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.close/index.html b/docs/en/gun/2.0/manual/gun.close/index.html new file mode 100644 index 00000000..abb39734 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.close/index.html @@ -0,0 +1,190 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:close(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:close(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:close - Brutally close the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">close</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()</tt></pre> +</div></div> +<p>Brutally close the connection.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Close the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">gun:close</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.shutdown">gun:shutdown(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.connect/index.html b/docs/en/gun/2.0/manual/gun.connect/index.html new file mode 100644 index 00000000..9117d3bd --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.connect/index.html @@ -0,0 +1,251 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:connect(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:connect(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:connect - Establish a tunnel to the origin server</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>) + <font color="#990000">-></font> <b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>, #{})<font color="#990000">.</font> + +<b><font color="#000000">connect</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Destination</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Destination</font> <font color="#990000">::</font> <b><font color="#000000">gun:connect_destination</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Establish a tunnel to the origin server.</p> +<p>This feature is currently only available for HTTP/1.1 connections. Upon successful completion of the CONNECT request a tunnel is established and subsequent requests will go through the tunnel.</p> +<p>Gun will not automatically re-issue the CONNECT request upon reconnection to the proxy server. The <code>gun_up</code> message can be used to know when the tunnel needs to be established again.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Destination</dt> +<dd><p>Destination of the CONNECT request.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.2</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Establish a tunnel</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>), +{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>), +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{ + <font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#FF0000">"origin-server.example.org"</font>, + <font color="#0000FF">port</font> <font color="#990000">=></font> <font color="#993399">80</font> +}), +{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), +<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Establish a tunnel for a secure HTTP/2 connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>), +{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>), +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{ + <font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#FF0000">"origin-server.example.org"</font>, + <font color="#0000FF">port</font> <font color="#990000">=></font> <font color="#993399">443</font>, + <font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>], + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tls</font> +}), +{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), +<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Establish a tunnel using proxy authorization</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"proxy.example.org"</font>, <font color="#993399">1080</font>), +{<font color="#FF6600">ok</font>, <font color="#FF6600">http</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>), +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:connect</font></b>(<font color="#009900">ConnPid</font>, #{ + <font color="#0000FF">host</font> <font color="#990000">=></font> <font color="#FF0000">"origin-server.example.org"</font>, + <font color="#0000FF">port</font> <font color="#990000">=></font> <font color="#993399">80</font>, + <font color="#0000FF">username</font> <font color="#990000">=></font> <font color="#FF0000">"essen"</font>, + <font color="#0000FF">password</font> <font color="#990000">=></font> <font color="#FF0000">"myrealpasswordis"</font> +}), +{<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#993399">200</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), +<i><font color="#9A1900">%% Subsequent requests will be sent to origin-server.example.org.</font></i></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.data/index.html b/docs/en/gun/2.0/manual/gun.data/index.html new file mode 100644 index 00000000..54d1ff90 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.data/index.html @@ -0,0 +1,209 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:data(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:data(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:data - Stream the body of a request</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()</tt></pre> +</div></div> +<p>Stream the body of a request.</p> +<p>This function can only be used if the original request had headers indicating that a body would be streamed.</p> +<p>All calls to this function must use the <code>nofin</code> flag except for the last which must use <code>fin</code> to indicate the end of the request body.</p> +<p>Empty data is allowed regardless of the value of <code>IsFin</code>. Gun may or may not send empty data chunks, however.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the request.</p> +</dd> +<dt>Data</dt> +<dd><p>All or part of the response body.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Stream the body of a request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonjour !\n"</font><font color="#990000">>></font>)<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonsoir !\n"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.headers">gun:headers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.delete/index.html b/docs/en/gun/2.0/manual/gun.delete/index.html new file mode 100644 index 00000000..0b83c626 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.delete/index.html @@ -0,0 +1,218 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:delete(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:delete(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:delete - Delete a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Delete a resource.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Delete a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/drafts/123"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Delete a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/drafts/123"</font>, [], + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.flush/index.html b/docs/en/gun/2.0/manual/gun.flush/index.html new file mode 100644 index 00000000..d07e5264 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.flush/index.html @@ -0,0 +1,203 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:flush(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:flush(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:flush - Flush all messages related to a connection or a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">flush</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> +<b><font color="#000000">flush</font></b>(<font color="#009900">StreamRef</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Flush all messages related to a connection or a stream.</p> +<h2 id="_arguments">Arguments</h2> +<p>Either of these arguments may be provided:</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Flush all messages from a connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Flush messages from a single stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.get/index.html b/docs/en/gun/2.0/manual/gun.get/index.html new file mode 100644 index 00000000..abb20b40 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.get/index.html @@ -0,0 +1,221 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:get(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:get(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:get - Get a resource representation</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Get a resource representation.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get a resource representation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get a resource representation with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [], #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font> +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.head/index.html b/docs/en/gun/2.0/manual/gun.head/index.html new file mode 100644 index 00000000..fb6662f2 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.head/index.html @@ -0,0 +1,223 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:head(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:head(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:head - Get headers of a resource representation</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Get headers of a resource representation.</p> +<p>This function performs the same operation as <a href="../gun.get">gun:get(3)</a>, except the server will not send the resource representation, only the response's status code and headers.</p> +<p>While servers are supposed to send the same headers as for a GET request, they sometimes will not. For example the <code>content-length</code> header may be dropped from the response.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Get headers of a resource representation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get headers of a resource representation with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [], #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font> +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:head(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.headers/index.html b/docs/en/gun/2.0/manual/gun.headers/index.html new file mode 100644 index 00000000..cbece0b0 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.headers/index.html @@ -0,0 +1,215 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:headers(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:headers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:headers - Initiate the given request</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">headers</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">headers</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">headers</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Initiate the given request.</p> +<p>This is a general purpose function that should only be used when other method-specific functions do not apply.</p> +<p>The function <code>headers/4,5</code> initiates a request but does not send the request body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Method</dt> +<dd><p>Method to be used for the request.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Initiate a request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:headers</font></b>(<font color="#009900">ConnPid</font>, <font color="#990000"><<</font><font color="#FF0000">"PUT"</font><font color="#990000">>></font>, + <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}])<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.info/index.html b/docs/en/gun/2.0/manual/gun.info/index.html new file mode 100644 index 00000000..bc8ccb13 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.info/index.html @@ -0,0 +1,212 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:info(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:info - Obtain information about the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">info</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#009900">Info</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> #{ + <b><font color="#000080">owner</font></b> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>(), + <font color="#0000FF">socket</font> <font color="#990000">=></font> <b><font color="#000000">inet:socket</font></b>() | <b><font color="#000000">ssl:sslsocket</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font>, + <font color="#0000FF">sock_ip</font> <font color="#990000">=></font> <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">sock_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">origin_host</font> <font color="#990000">=></font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">origin_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">intermediaries</font> <font color="#990000">=></font> [<font color="#009900">Intermediary</font>] +} +<font color="#009900">Intermediary</font> <font color="#990000">::</font> #{ + <font color="#0000FF">type</font> <font color="#990000">=></font> <font color="#FF6600">connect</font> | <font color="#FF6600">socks5</font>, + <font color="#0000FF">host</font> <font color="#990000">=></font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">protocol</font> <font color="#990000">=></font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> +}</tt></pre> +</div></div> +<p>Obtain information about the connection.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A map is returned containing various informations about the connection.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The value <code>owner</code> was added. +</li> +<li><strong>1.3</strong>: The values <code>socket</code>, <code>transport</code>, <code>protocol</code>, <code>origin_host</code>, <code>origin_port</code> and <code>intermediaries</code> were added. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Obtain information about the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Info</font> <font color="#990000">=</font> <b><font color="#000000">gun:info</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.open/index.html b/docs/en/gun/2.0/manual/gun.open/index.html new file mode 100644 index 00000000..ee859c8e --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.open/index.html @@ -0,0 +1,218 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:open(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:open(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:open - Open a connection to the given host and port</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>) <font color="#990000">-></font> <b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>, #{}) +<b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000080">pid</font></b>()} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">Host</font> <font color="#990000">::</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>() +<font color="#009900">Port</font> <font color="#990000">::</font> <b><font color="#000000">inet:port_number</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">gun:opts</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">options</font>, <font color="#009900">OptName</font>} + | {<font color="#FF6600">options</font>, {<font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font>, <font color="#009900">OptName</font>}} + | <b><font color="#000000">any</font></b>() +<font color="#009900">OptName</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()</tt></pre> +</div></div> +<p>Open a connection to the given host and port.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Host</dt> +<dd><p>Host or IP address to connect to.</p> +</dd> +<dt>Port</dt> +<dd><p>Port to connect to.</p> +</dd> +<dt>Opts</dt> +<dd><p>Options for this connection.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the <a href="../gun_up">gun_up(3)</a> message will be sent for that.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Connect to a server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server with custom options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>, + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>]})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server using its IP address</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>({<font color="#993399">127</font>,<font color="#993399">0</font>,<font color="#993399">0</font>,<font color="#993399">1</font>}, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_socks_up">gun_socks_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.open_unix/index.html b/docs/en/gun/2.0/manual/gun.open_unix/index.html new file mode 100644 index 00000000..5c15df10 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.open_unix/index.html @@ -0,0 +1,206 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:open_unix(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:open_unix(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:open_unix - Open a connection to the given Unix domain socket</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">open_unix</font></b>(<font color="#009900">SocketPath</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000080">pid</font></b>()} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">SocketPath</font> <font color="#990000">::</font> <b><font color="#000000">string</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">gun:opts</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> {<font color="#FF6600">options</font>, <font color="#009900">OptName</font>} + | {<font color="#FF6600">options</font>, {<font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font>, <font color="#009900">OptName</font>}} + | <b><font color="#000000">any</font></b>() +<font color="#009900">OptName</font> <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()</tt></pre> +</div></div> +<p>Open a connection to the given Unix domain socket.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>SocketPath</dt> +<dd><p>Path to the Unix domain socket to connect to.</p> +</dd> +<dt>Opts</dt> +<dd><p>Options for this connection.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the <a href="../gun_up">gun_up(3)</a> message will be sent for that.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Connect to a server via a Unix domain socket</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open_unix</font></b>(<font color="#FF0000">"/var/run/dbus/system_bus_socket"</font>, #{})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server via a Unix domain socket with custom options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open_unix</font></b>(<font color="#FF0000">"/var/run/dbus/system_bus_socket"</font>, + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>]})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_socks_up">gun_socks_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.options/index.html b/docs/en/gun/2.0/manual/gun.options/index.html new file mode 100644 index 00000000..441f1199 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.options/index.html @@ -0,0 +1,218 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:options(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:options(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:options - Query the capabilities of the server or a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Query the capabilities of the server or a resource.</p> +<p>The special path <code>"*"</code> can be used to obtain information about the server as a whole. Any other path will return information about that resource specifically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Query the capabilities of the server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"*"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Query the capabilities of a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.patch/index.html b/docs/en/gun/2.0/manual/gun.patch/index.html new file mode 100644 index 00000000..55186a18 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.patch/index.html @@ -0,0 +1,246 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:patch(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:patch(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:patch - Apply a set of changes to a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Apply a set of changes to a resource.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>patch/3,4</code> does not send a body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>patch/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<p>The body sent in this request should be a patch document with instructions on how to update the resource.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using separate calls. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Patch a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Patch a resource in multiple calls</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Patch a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.post/index.html b/docs/en/gun/2.0/manual/gun.post/index.html new file mode 100644 index 00000000..0001b069 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.post/index.html @@ -0,0 +1,244 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:post(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:post(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:post - Process the enclosed representation according to a resource's own semantics</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Process the enclosed representation according to a resource's own semantics.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>post/3,4</code> does not send a body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>post/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using separate calls. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Post to a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Post to a resource in multiple calls</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Post to a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.put/index.html b/docs/en/gun/2.0/manual/gun.put/index.html new file mode 100644 index 00000000..1352ee43 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.put/index.html @@ -0,0 +1,244 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:put(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:put(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:put - Create or replace a resource</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Create or replace a resource.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>put/3,4</code> does not send a body. It must be sent separately using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>put/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using separate calls. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Put a resource</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Put a resource in multiple calls</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Put a resource with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.request/index.html b/docs/en/gun/2.0/manual/gun.request/index.html new file mode 100644 index 00000000..dcdeacec --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.request/index.html @@ -0,0 +1,222 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:request(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:request(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:request - Perform the given request</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Perform the given request.</p> +<p>This is a general purpose function that should only be used when other method-specific functions do not apply.</p> +<p>The function <code>request/5,6</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Method</dt> +<dd><p>Method to be used for the request.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>Body</dt> +<dd><p>Request body.</p> +</dd> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Implicit body detection has been removed. The body must now be provided either directly (even if empty) or using <a href="../gun.headers">gun:headers(3)</a>. +</li> +<li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Perform a request</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:request</font></b>(<font color="#009900">ConnPid</font>, <font color="#990000"><<</font><font color="#FF0000">"PUT"</font><font color="#990000">>></font>, + <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.set_owner/index.html b/docs/en/gun/2.0/manual/gun.set_owner/index.html new file mode 100644 index 00000000..661aa535 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.set_owner/index.html @@ -0,0 +1,196 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:set_owner(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:set_owner(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:set_owner - Set a new owner for the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">set_owner</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">OwnerPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">OwnerPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()</tt></pre> +</div></div> +<p>Set a new owner for the connection.</p> +<p>Only the current owner of the connection can set a new owner.</p> +<p>Gun monitors the owner of the connection and automatically shuts down gracefully when the owner exits.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>OwnerPid</dt> +<dd><p>The pid of the new owner for the connection.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Set a new owner for the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">gun:set_owner</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">OwnerPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.shutdown">gun:shutdown(3)</a>, <a href="../gun.close">gun:close(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.shutdown/index.html b/docs/en/gun/2.0/manual/gun.shutdown/index.html new file mode 100644 index 00000000..76f8ee21 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.shutdown/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:shutdown(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:shutdown(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:shutdown - Gracefully close the connection</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#000080">shutdown</font>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()</tt></pre> +</div></div> +<p>Gracefully close the connection.</p> +<p>Gun will wait for up to <code>closing_timeout</code> milliseconds before brutally closing the connection. The graceful shutdown mechanism varies between the different protocols:</p> +<ul><li>For HTTP/1.1 there is no such mechanism and Gun will close the connection once the current response is received. Any pipelined requests are immediately terminated. +</li> +<li>For HTTP/2 Gun will send a GOAWAY frame and wait for the existing streams to terminate. +</li> +<li>For Websocket Gun will send a close frame and wait for the server's close frame before closing the connection. +</li> +</ul> +<p>The function returns immediately. The connection may therefore still be up for some time after this call.</p> +<p>Gun will not attempt to reconnect once graceful shutdown has been initiated.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Gracefully shutdown the connection</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">gun:shutdown</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.close">gun:close(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.stream_info/index.html b/docs/en/gun/2.0/manual/gun.stream_info/index.html new file mode 100644 index 00000000..183d9ade --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.stream_info/index.html @@ -0,0 +1,199 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:stream_info(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:stream_info(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:stream_info - Obtain information about a stream</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">stream_info</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#000080">undefined</font> | <font color="#009900">Info</font>} | {<font color="#FF6600">error</font>, <font color="#FF6600">not_connected</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> #{ + <font color="#0000FF">ref</font> <font color="#990000">=></font> <b><font color="#000080">reference</font></b>(), + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>(), + <font color="#0000FF">state</font> <font color="#990000">=></font> <b><font color="#000080">running</font></b> | <font color="#FF6600">stopping</font> +}</tt></pre> +</div></div> +<p>Obtain information about a stream.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A map is returned containing various informations about the stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Obtain information about a stream</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Info</font> <font color="#990000">=</font> <b><font color="#000000">gun:stream_info</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.cancel">gun:cancel(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.update_flow/index.html b/docs/en/gun/2.0/manual/gun.update_flow/index.html new file mode 100644 index 00000000..52f113eb --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.update_flow/index.html @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:update_flow(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:update_flow(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:update_flow - Update a stream's flow control value</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">update_flow</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Flow</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Flow</font> <font color="#990000">::</font> <b><font color="#000000">pos_integer</font></b>()</tt></pre> +</div></div> +<p>Update a stream's flow control value.</p> +<p>The flow value can only ever be incremented.</p> +<p>This function does nothing for streams that have flow control disabled (which is the default).</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Flow</dt> +<dd><p>Flow control value increment.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Update a stream's flow control value</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:update_flow</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">10</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.ws_send/index.html b/docs/en/gun/2.0/manual/gun.ws_send/index.html new file mode 100644 index 00000000..c1677abe --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.ws_send/index.html @@ -0,0 +1,208 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:ws_send(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:ws_send(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:ws_send - Send Websocket frames</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_send</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Frames</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Frames</font> <font color="#990000">::</font> <font color="#009900">Frame</font> | [<font color="#009900">Frame</font>] +<font color="#009900">Frame</font> <font color="#990000">::</font> <font color="#FF6600">close</font> | <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font> + | {<font color="#FF6600">text</font> | <b><font color="#000080">binary</font></b> | <font color="#FF6600">close</font> | <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font>, <b><font color="#000000">iodata</font></b>()} + | {<font color="#FF6600">close</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<p>Send Websocket frames.</p> +<p>The connection must first be upgraded to Websocket using the function <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Frames</dt> +<dd><p>One or more Websocket frame(s).</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The atom <code>ok</code> is returned.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Send a single frame</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Send many frames including a close frame</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, [ + {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"See you later, world!"</font><font color="#990000">>></font>}, + <font color="#FF6600">close</font> +])<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun.ws_upgrade/index.html b/docs/en/gun/2.0/manual/gun.ws_upgrade/index.html new file mode 100644 index 00000000..3121f8c0 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun.ws_upgrade/index.html @@ -0,0 +1,231 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:ws_upgrade(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:ws_upgrade(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:ws_upgrade - Upgrade to Websocket</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, []) + +<b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">WsOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_headers</font></b>() +<font color="#009900">WsOpts</font> <font color="#990000">::</font> <font color="#FF6600">gun</font><font color="#990000">:</font><font color="#FF6600">ws_opts</font> +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Upgrade to Websocket.</p> +<p>The behavior of this function depends on the protocol selected.</p> +<p>HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if successful, will result in the complete takeover of the connection. Any subsequent HTTP requests will be rejected.</p> +<p>Gun does not currently support Websocket over HTTP/2.</p> +<p>By default Gun will take the Websocket options from the connection's <code>ws_opts</code>.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Path</dt> +<dd><p>Path to the resource.</p> +</dd> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> +</dd> +<dt>WsOpts</dt> +<dd><p>Configuration for the Websocket protocol.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Upgrade to Websocket</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/ws"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"sec-websocket-protocol"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"chat"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>], <font color="#990000">_</font>} <font color="#990000">-></font> + <font color="#FF6600">ok</font> +<b><font color="#0000FF">after</font></b> <font color="#993399">5000</font> <font color="#990000">-></font> + <b><font color="#000000">error</font></b>(<font color="#FF6600">timeout</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Upgrade to Websocket with different options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/ws"</font>, [], #{ + <font color="#0000FF">compress</font> <font color="#990000">=></font> <font color="#000080">false</font> +})<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun/index.html b/docs/en/gun/2.0/manual/gun/index.html new file mode 100644 index 00000000..ea092254 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun/index.html @@ -0,0 +1,586 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun - Asynchronous HTTP client</p> +<h2 id="_description">Description</h2> +<p>The <code>gun</code> module provides an asynchronous interface for connecting and communicating with Web servers over HTTP, HTTP/2 or Websocket.</p> +<h2 id="_exports">Exports</h2> +<p>Connection:</p> +<ul><li><a href="../gun.open">gun:open(3)</a> - Open a connection to the given host and port +</li> +<li><a href="../gun.open_unix">gun:open_unix(3)</a> - Open a connection to the given Unix domain socket +</li> +<li><a href="../gun.set_owner">gun:set_owner(3)</a> - Set a new owner for the connection +</li> +<li><a href="../gun.shutdown">gun:shutdown(3)</a> - Gracefully close the connection +</li> +<li><a href="../gun.close">gun:close(3)</a> - Brutally close the connection +</li> +<li><a href="../gun.info">gun:info(3)</a> - Obtain information about the connection +</li> +</ul> +<p>Requests:</p> +<ul><li><a href="../gun.get">gun:get(3)</a> - Get a resource representation +</li> +<li><a href="../gun.head">gun:head(3)</a> - Get headers of a resource representation +</li> +<li><a href="../gun.options">gun:options(3)</a> - Query the capabilities of the server or a resource +</li> +<li><a href="../gun.patch">gun:patch(3)</a> - Apply a set of changes to a resource +</li> +<li><a href="../gun.post">gun:post(3)</a> - Process the enclosed representation according to a resource's own semantics +</li> +<li><a href="../gun.put">gun:put(3)</a> - Create or replace a resource +</li> +<li><a href="../gun.delete">gun:delete(3)</a> - Delete a resource +</li> +<li><a href="../gun.headers">gun:headers(3)</a> - Initiate the given request +</li> +<li><a href="../gun.request">gun:request(3)</a> - Perform the given request +</li> +<li><a href="../gun.data">gun:data(3)</a> - Stream the body of a request +</li> +</ul> +<p>Proxies:</p> +<ul><li><a href="../gun.connect">gun:connect(3)</a> - Establish a tunnel to the origin server +</li> +</ul> +<p>Messages:</p> +<ul><li><a href="../gun.await">gun:await(3)</a> - Wait for a response +</li> +<li><a href="../gun.await_body">gun:await_body(3)</a> - Wait for the complete response body +</li> +<li><a href="../gun.await_up">gun:await_up(3)</a> - Wait for the connection to be up +</li> +<li><a href="../gun.flush">gun:flush(3)</a> - Flush all messages related to a connection or a stream +</li> +</ul> +<p>Streams:</p> +<ul><li><a href="../gun.update_flow">gun:update_flow(3)</a> - Update a stream's flow control value +</li> +<li><a href="../gun.cancel">gun:cancel(3)</a> - Cancel the given stream +</li> +<li><a href="../gun.stream_info">gun:stream_info(3)</a> - Obtain information about a stream +</li> +</ul> +<p>Websocket:</p> +<ul><li><a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a> - Upgrade to Websocket +</li> +<li><a href="../gun.ws_send">gun:ws_send(3)</a> - Send Websocket frames +</li> +</ul> +<h2 id="_messages">Messages</h2> +<p>Gun will inform the calling process of events asynchronously by sending any of the following messages:</p> +<p>Connection:</p> +<ul><li><a href="../gun_up">gun_up(3)</a> - The connection is up +</li> +<li><a href="../gun_socks_up">gun_socks_up(3)</a> - The Socks connection is up +</li> +<li><a href="../gun_down">gun_down(3)</a> - The connection is down +</li> +<li><a href="../gun_upgrade">gun_upgrade(3)</a> - Successful protocol upgrade +</li> +<li><a href="../gun_error">gun_error(3)</a> - Stream or connection-wide error +</li> +</ul> +<p>Responses:</p> +<ul><li><a href="../gun_push">gun_push(3)</a> - Server-initiated push +</li> +<li><a href="../gun_inform">gun_inform(3)</a> - Informational response +</li> +<li><a href="../gun_response">gun_response(3)</a> - Response +</li> +<li><a href="../gun_data">gun_data(3)</a> - Response body +</li> +<li><a href="../gun_trailers">gun_trailers(3)</a> - Response trailers +</li> +</ul> +<p>Websocket:</p> +<ul><li><a href="../gun_ws">gun_ws(3)</a> - Websocket frame +</li> +</ul> +<p>The response messages will be sent to the process that opened the connection by default. The <code>reply_to</code> request option can be used to redirect request-specific messages to a different process.</p> +<h2 id="_types">Types</h2> +<h3 id="_connect_destination">connect_destination()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">connect_destination</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">host</font> <font color="#990000">:=</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#FF6600">port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>(), + + <font color="#0000FF">username</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">password</font> <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>(), + <font color="#0000FF">protocols</font> <font color="#990000">=></font> <b><font color="#000000">protocols</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + + <font color="#0000FF">tls_opts</font> <font color="#990000">=></font> [<b><font color="#000000">ssl:tls_client_option</font></b>()], + <font color="#0000FF">tls_handshake_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Destination of a CONNECT request.</p> +<p>The default value, if any, is given next to the option name:</p> +<dl><dt>host, port</dt> +<dd><p>Destination hostname and port number. Mandatory.</p> +<p>Upon successful completion of the CONNECT request, Gun will begin using these as the host and port of the origin server for subsequent requests.</p> +</dd> +<dt>username, password</dt> +<dd><p>Proxy authorization credentials. They are only sent when both options are provided.</p> +</dd> +<dt>protocols - see below</dt> +<dd><p>Ordered list of preferred protocols. Please refer to the <code>protocols()</code> type documentation for details.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +</dd> +<dt>transport (tcp)</dt> +<dd><p>Transport that will be used for tunneled requests.</p> +</dd> +<dt>tls_opts ([])</dt> +<dd><p>Options to use for tunneled TLS connections.</p> +</dd> +<dt>tls_handshake_timeout (infinity)</dt> +<dd><p>Handshake timeout for tunneled TLS connections.</p> +</dd> +</dl> +<h3 id="_http_opts">http_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">http_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">transform_header_name</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000080">binary</font></b>()) <font color="#990000">-></font> <b><font color="#000080">binary</font></b>()), + <font color="#0000FF">version</font> <font color="#990000">=></font> <font color="#FF6600">'HTTP/1.1'</font> | <font color="#FF6600">'HTTP/1.0'</font> +}</tt></pre> +</div></div> +<p>Configuration for the HTTP protocol.</p> +<p>The default value is given next to the option name:</p> +<!-- @todo Document content_handlers and gun_sse_h.--> +<dl><dt>closing_timeout (15000)</dt> +<dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested via a call to <a href="../gun.shutdown">gun:shutdown(3)</a>.</p> +</dd> +<dt>flow - see below</dt> +<dd><p>The initial flow control value for all HTTP/1.1 streams. By default flow control is disabled.</p> +</dd> +<dt>keepalive (infinity)</dt> +<dd><p>Time between pings in milliseconds. Since the HTTP protocol has no standardized way to ping the server, Gun will simply send an empty line when the connection is idle. Gun only makes a best effort here as servers usually have configurable limits to drop idle connections. Disabled by default due to potential incompatibilities.</p> +</dd> +<dt>transform_header_name - see below</dt> +<dd><p>A function that will be applied to all header names before they are sent to the server. Gun assumes that all header names are in lower case. This function is useful if you, for example, need to re-case header names in the event that the server incorrectly considers the case of header names to be significant.</p> +</dd> +<dt>version (<code>'HTTP/1.1'</code>)</dt> +<dd><p>HTTP version to use.</p> +</dd> +</dl> +<h3 id="_http2_opts">http2_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">http2_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the HTTP/2 protocol.</p> +<p>The default value is given next to the option name:</p> +<!-- @todo Document content_handlers and gun_sse_h.--> +<dl><dt>closing_timeout (15000)</dt> +<dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested either via a call to <a href="../gun.shutdown">gun:shutdown(3)</a> or by the server.</p> +</dd> +<dt>flow - see below</dt> +<dd><p>The initial flow control value for all HTTP/2 streams. By default flow control is disabled.</p> +</dd> +<dt>keepalive (5000)</dt> +<dd><p>Time between pings in milliseconds.</p> +</dd> +</dl> +<!-- @todo Allow and document max_frame_size_sent.--> +<h3 id="_opts">opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">connect_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">domain_lookup_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">http_opts</font> <font color="#990000">=></font> <b><font color="#000000">http_opts</font></b>(), + <font color="#0000FF">http2_opts</font> <font color="#990000">=></font> <b><font color="#000000">http2_opts</font></b>(), + <font color="#0000FF">protocols</font> <font color="#990000">=></font> <b><font color="#000000">protocols</font></b>(), + <font color="#0000FF">retry</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">retry_fun</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>(), + <font color="#0000FF">retry_timeout</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">supervise</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">tcp_opts</font> <font color="#990000">=></font> [<b><font color="#000000">gen_tcp:connect_option</font></b>()], + <font color="#0000FF">tls_handshake_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">tls_opts</font> <font color="#990000">=></font> [<b><font color="#000000">ssl:tls_client_option</font></b>()], + <font color="#0000FF">trace</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">ws_opts</font> <font color="#990000">=></font> <b><font color="#000000">ws_opts</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the connection.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>connect_timeout (infinity)</dt> +<dd><p>Connection timeout.</p> +</dd> +<dt>domain_lookup_timeout (infinity)</dt> +<dd><p>Domain lookup timeout.</p> +</dd> +<dt>http_opts (#{})</dt> +<dd><p>Options specific to the HTTP protocol.</p> +</dd> +<dt>http2_opts (#{})</dt> +<dd><p>Options specific to the HTTP/2 protocol.</p> +</dd> +<dt>protocols - see below</dt> +<dd><p>Ordered list of preferred protocols. Please refer to the <code>protocols()</code> type documentation for details.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +</dd> +<dt>retry (5)</dt> +<dd><p>Number of times Gun will try to reconnect on failure before giving up.</p> +</dd> +<dt>retry_fun - see below</dt> +<dd><p>A fun that will be called before every reconnect attempt. It receives the current number of retries left and the Gun options. It returns the next number of retries left and the timeout to apply before reconnecting.</p> +</dd> +</dl> +<p>The default fun will remove one to the number of retries and set the timeout to the <code>retry_timeout</code> value.</p> +<p>The fun must be defined as follow:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#0000FF">fun</font></b> ((<b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000000">opts</font></b>()) <font color="#990000">-></font> #{ + <font color="#0000FF">retries</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">timeout</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>() +})</tt></pre> +</div></div> +<p>The fun will never be called when the <code>retry</code> option is set to 0. When this function returns 0 in the <code>retries</code> value, Gun will do one last reconnect attempt before giving up.</p> +<dl><dt>retry_timeout (5000)</dt> +<dd><p>Time between retries in milliseconds.</p> +</dd> +<dt>supervise (true)</dt> +<dd><p>Whether the Gun process should be started under the <code>gun_sup</code> supervisor. Set to <code>false</code> to use your own supervisor.</p> +</dd> +<dt>tcp_opts ([])</dt> +<dd><p>TCP options used when establishing the connection.</p> +</dd> +<dt>tls_handshake_timeout (infinity)</dt> +<dd><p>TLS handshake timeout.</p> +</dd> +<dt>tls_opts ([])</dt> +<dd><p>TLS options used for the TLS handshake after the connection has been established, when the transport is set to <code>tls</code>.</p> +</dd> +<dt>trace (false)</dt> +<dd><p>Whether to enable <code>dbg</code> tracing of the connection process. Should only be used during debugging.</p> +</dd> +<dt>transport - see below</dt> +<dd><p>Whether to use TLS or plain TCP. The default varies depending on the port used. Port 443 defaults to <code>tls</code>. All other ports default to <code>tcp</code>.</p> +</dd> +<dt>ws_opts (#{})</dt> +<dd><p>Options specific to the Websocket protocol.</p> +</dd> +</dl> +<h3 id="_protocols">protocols()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">protocols</font></b>() <font color="#990000">::</font> <font color="#FF6600">http</font> | {<font color="#FF6600">http</font>, <b><font color="#000000">http_opts</font></b>()} + | <font color="#FF6600">http2</font> | {<font color="#FF6600">http2</font>, <b><font color="#000000">http2_opts</font></b>()} + | <font color="#FF6600">socks</font> | {<font color="#FF6600">socks</font>, <b><font color="#000000">socks_opts</font></b>()}</tt></pre> +</div></div> +<p>Ordered list of preferred protocols. When the transport is <code>tcp</code>, this list must contain exactly one protocol. When the transport is <code>tls</code>, this list must contain at least one protocol and will be used to negotiate a protocol via ALPN. When the server does not support ALPN then <code>http</code> will be used, except when the list of preferred protocols is set to only accept <code>socks</code>.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +<h3 id="_req_headers">req_headers()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req_headers</font></b>() <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>() | <b><font color="#000000">string</font></b>() | <b><font color="#000080">atom</font></b>(), <b><font color="#000000">iodata</font></b>()}] + | #{<b><font color="#000080">binary</font></b>() | <b><font color="#000000">string</font></b>() | <b><font color="#000080">atom</font></b>() <font color="#990000">=></font> <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<p>Request headers.</p> +<h3 id="_req_opts">req_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">req_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for a particular request.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>flow - see below</dt> +<dd><p>The initial flow control value for the stream. By default flow control is disabled.</p> +</dd> +<dt>reply_to (<code>self()</code>)</dt> +<dd><p>The pid of the process that will receive the response messages.</p> +</dd> +</dl> +<h3 id="_socks_opts">socks_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">socks_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#FF6600">host</font> <font color="#990000">:=</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#FF6600">port</font> <font color="#990000">:=</font> <b><font color="#000000">inet:port_number</font></b>(), + + <font color="#0000FF">auth</font> <font color="#990000">=></font> [{<font color="#FF6600">username_password</font>, <b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()} | <font color="#FF6600">none</font>], + <font color="#0000FF">protocols</font> <font color="#990000">=></font> <b><font color="#000000">protocols</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">version</font> <font color="#990000">=></font> <font color="#993399">5</font>, + + <font color="#0000FF">tls_opts</font> <font color="#990000">=></font> [<b><font color="#000000">ssl:tls_client_option</font></b>()], + <font color="#0000FF">tls_handshake_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the Socks protocol.</p> +<p>The default value, if any, is given next to the option name:</p> +<dl><dt>host, port</dt> +<dd><p>Destination hostname and port number. Mandatory.</p> +<p>Upon successful completion of the Socks connection, Gun will begin using these as the host and port of the origin server for subsequent requests.</p> +</dd> +<dt>auth ([none])</dt> +<dd><p>Authentication methods Gun advertises to the Socks proxy.</p> +</dd> +<dt>protocols - see below</dt> +<dd><p>Ordered list of preferred protocols. Please refer to the <code>protocols()</code> type documentation for details.</p> +<p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +</dd> +<dt>transport (tcp)</dt> +<dd><p>Transport that will be used for tunneled requests.</p> +</dd> +<dt>tls_opts ([])</dt> +<dd><p>Options to use for tunneled TLS connections.</p> +</dd> +<dt>tls_handshake_timeout (infinity)</dt> +<dd><p>Handshake timeout for tunneled TLS connections.</p> +</dd> +<dt>version (5)</dt> +<dd><p>Version of the Socks protocol to use.</p> +</dd> +</dl> +<h3 id="_ws_opts">ws_opts()</h3> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">ws_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">compress</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">protocols</font> <font color="#990000">=></font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">module</font></b>()}], + <font color="#0000FF">silence_pings</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the Websocket protocol.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>closing_timeout (15000)</dt> +<dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested either via a call to <a href="../gun.shutdown">gun:shutdown(3)</a> or by the server.</p> +</dd> +<dt>compress (false)</dt> +<dd><p>Whether to enable permessage-deflate compression. This does not guarantee that compression will be used as it is the server that ultimately decides. Defaults to false.</p> +</dd> +<dt>flow - see below</dt> +<dd><p>The initial flow control value for the Websocket connection. By default flow control is disabled.</p> +</dd> +<dt>keepalive (5000)</dt> +<dd><p>Time between pings in milliseconds.</p> +</dd> +<dt>protocols ([])</dt> +<dd><p>A non-empty list enables Websocket protocol negotiation. The list of protocols will be sent in the sec-websocket-protocol request header. The handler module interface is currently undocumented and must be set to <code>gun_ws_h</code>.</p> +</dd> +<dt>silence_pings (true)</dt> +<dd><p>Whether the ping and pong frames should be sent to the user. In all cases Gun will automatically send a pong frame back when receiving a ping.</p> +</dd> +</dl> +<!-- @todo Document default_protocol and user_opts.--> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The types <code>protocols()</code> and <code>socks_opts()</code> have been added. Support for the Socks protocol has been added in every places where protocol selection is available. In addition it is now possible to specify separate HTTP options for the CONNECT proxy and the origin server. +</li> +<li><strong>2.0</strong>: The <code>connect_timeout</code> option has been split into three options: <code>domain_lookup_timeout</code>, <code>connect_timeout</code> and when applicable <code>tls_handshake_timeout</code>. +</li> +<li><strong>2.0</strong>: The option <code>retry_fun</code> was added. It can be used to implement different reconnect strategies. +</li> +<li><strong>2.0</strong>: The <code>transport_opts</code> option has been split into two options: <code>tcp_opts</code> and <code>tls_opts</code>. +</li> +<li><strong>2.0</strong>: Function <code>gun:update_flow/3</code> introduced. The <code>flow</code> option was added to request options and HTTP/1.1, HTTP/2 and Websocket options as well. +</li> +<li><strong>2.0</strong>: Introduce the type <code>req_headers()</code> and extend the types accepted for header names for greater interoperability. Header names are automatically lowercased as well. +</li> +<li><strong>2.0</strong>: Function <code>gun:headers/4,5</code> introduced. +</li> +<li><strong>2.0</strong>: The <code>keepalive</code> option is now set to <code>infinity</code> by default for the HTTP/1.1 protocol, disabling it. +</li> +<li><strong>2.0</strong>: Websocket options <code>keepalive</code> and <code>silence_pings</code> introduced. +</li> +<li><strong>1.3</strong>: Add the CONNECT destination's <code>protocols</code> option and deprecate the previously introduced <code>protocol</code> option. +</li> +<li><strong>1.2</strong>: Introduce the type <code>connect_destination()</code>. +</li> +</ul> +<h2 id="_see_also">See also</h2> +<p><a href="..">gun(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_app/index.html b/docs/en/gun/2.0/manual/gun_app/index.html new file mode 100644 index 00000000..5c160cb1 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_app/index.html @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun(7)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun(7)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p> +<h2 id="_description">Description</h2> +<p>Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.</p> +<h2 id="_modules">Modules</h2> +<ul><li><a href="../gun">gun(3)</a> - Asynchronous HTTP client +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li><a href="../cowlib">cowlib(7)</a> - Support library for manipulating Web protocols +</li> +<li>ssl - Secure communication over sockets +</li> +</ul> +<p>All these applications must be started before the <code>gun</code> application. To start Gun and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>gun</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="../cowlib">cowlib(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_data/index.html b/docs/en/gun/2.0/manual/gun_data/index.html new file mode 100644 index 00000000..43b2bf95 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_data/index.html @@ -0,0 +1,207 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_data(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_data(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_data - Response body</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Response body.</p> +<p>This message informs the relevant process that the server sent a all or part of the body for the response to the original request.</p> +<p>A data message is always preceded by a response message.</p> +<p>The response body may be terminated either by a data message with the flag <code>fin</code> set or by a <a href="../gun_trailers">gun_trailers(3)</a> message.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the response.</p> +</dd> +<dt>Data</dt> +<dd><p>All or part of the response body.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_data message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_IsFin</font>, <font color="#009900">_Data</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_trailers">gun_trailers(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_down/index.html b/docs/en/gun/2.0/manual/gun_down/index.html new file mode 100644 index 00000000..28deb588 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_down/index.html @@ -0,0 +1,209 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_down(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_down(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_down - The connection is down</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_down</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>, <font color="#009900">Reason</font>, <font color="#009900">KilledStreams</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font> | <font color="#FF6600">ws</font> +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">KilledStreams</font> <font color="#990000">::</font> [<b><font color="#000080">reference</font></b>()]</tt></pre> +</div></div> +<p>The connection is down.</p> +<p>This message informs the owner process that the connection was lost. Depending on the <code>retry</code> and <code>retry_timeout</code> options Gun may automatically attempt to reconnect.</p> +<p>When the connection goes back up, Gun will not attempt to retry requests. It will also not upgrade to Websocket automatically if that was the protocol in use when the connection was lost.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol that was selected for this connection or upgraded to during the course of the connection.</p> +</dd> +<dt>Reason</dt> +<dd><p>The reason for the loss of the connection.</p> +<p>It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.</p> +</dd> +<dt>KilledStreams</dt> +<dd><p>List of streams that have been brutally terminated.</p> +<p>They are active streams that did not complete before the closing of the connection. Whether they can be retried safely depends on the protocol used and the idempotence property of the requests.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The last element of the message's tuple, <code>UnprocessedStreams</code> has been removed. +</li> +<li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_down message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_down</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>, <font color="#009900">_Reason</font>, <font color="#009900">_Killed</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_socks_up">gun_socks_up(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_error/index.html b/docs/en/gun/2.0/manual/gun_error/index.html new file mode 100644 index 00000000..bdd633f9 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_error/index.html @@ -0,0 +1,206 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_error(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_error(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_error - Stream or connection-wide error</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Reason</font>} +{<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Stream or connection-wide error.</p> +<p>These messages inform the relevant process that an error occurred. A reference is given when the error pertains to a specific stream. Connection-wide errors do not imply that the connection is no longer usable, they are used for all errors that are not specific to a stream.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that resulted in an error.</p> +</dd> +<dt>Reason</dt> +<dd><p>The reason for the error.</p> +<p>It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_error message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Reason</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}; +<b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Reason</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_socks_up">gun_socks_up(3)</a>, <a href="../gun_down">gun_down(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_inform/index.html b/docs/en/gun/2.0/manual/gun_inform/index.html new file mode 100644 index 00000000..3de67dbd --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_inform/index.html @@ -0,0 +1,206 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_inform(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_inform(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_inform - Informational response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_inform</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Status</font> <font color="#990000">::</font> <font color="#993399">100</font><font color="#990000">..</font><font color="#993399">199</font> +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Informational response.</p> +<p>This message informs the relevant process that the server sent an informational response to the original request.</p> +<p>Informational responses are only intermediate responses and provide no guarantees as to what the final response will be. An informational response always precedes the response to the original request.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Status</dt> +<dd><p>Status code for the informational response.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers sent with the informational response.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_inform message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_inform</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_Status</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_push/index.html b/docs/en/gun/2.0/manual/gun_push/index.html new file mode 100644 index 00000000..5acd341c --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_push/index.html @@ -0,0 +1,226 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_push(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_push(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_push - Server-initiated push</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">NewStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">NewStreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Server-initiated push.</p> +<p>This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request.</p> +<p>A server-initiated push message always precedes the response to the original request.</p> +<p>This message will not be sent when using the HTTP/1.1 protocol because it lacks the concept of server-initiated push.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>NewStreamRef</dt> +<dd><p>Identifier of the stream being pushed.</p> +</dd> +<dt>Method</dt> +<dd><p>Method of the equivalent HTTP request.</p> +</dd> +<dt>URI</dt> +<dd><p>URI of the resource being pushed.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers of the equivalent HTTP request.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_push message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_NewStreamRef</font>, <font color="#009900">_Method</font>, <font color="#009900">_URI</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Cancel an unwanted push</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">NewStreamRef</font>, <font color="#009900">_Method</font>, <font color="#009900">_URI</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">NewStreamRef</font>), + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.cancel">gun:cancel(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_response/index.html b/docs/en/gun/2.0/manual/gun_response/index.html new file mode 100644 index 00000000..5a06b764 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_response/index.html @@ -0,0 +1,209 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_response(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_response(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_response - Response</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Status</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Response.</p> +<p>This message informs the relevant process that the server sent a response to the original request.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the response.</p> +</dd> +<dt>Status</dt> +<dd><p>Status code for the response.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers sent with the response.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_response message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_IsFin</font>, <font color="#009900">_Status</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_push">gun_push(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_socks_up/index.html b/docs/en/gun/2.0/manual/gun_socks_up/index.html new file mode 100644 index 00000000..6fcbc69b --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_socks_up/index.html @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_socks_up(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_socks_up(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_socks_up - The Socks connection is up</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_socks_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font></tt></pre> +</div></div> +<p>The Socks connection is up.</p> +<p>This message informs the owner/calling process that the connection completed through the configured Socks proxy.</p> +<p>If Gun is configured to connect to another Socks server, then the connection is not usable yet. One or more <a href="../gun_socks_up">gun_socks_up(3)</a> messages will follow.</p> +<p>Otherwise, Gun will start processing the messages it received while waiting for the connection to be up. If this is a reconnection, then this may not be desirable for all requests. Those requests should be cancelled when the connection goes down, and any subsequent messages ignored.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol selected for this connection. It can be used to determine the capabilities of the server.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_socks_up message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_socks_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_down">gun_down(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_trailers/index.html b/docs/en/gun/2.0/manual/gun_trailers/index.html new file mode 100644 index 00000000..dc3bc169 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_trailers/index.html @@ -0,0 +1,201 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_trailers(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_trailers(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_trailers - Response trailers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_trailers</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Response trailers.</p> +<p>This message informs the relevant process that the server sent response trailers for the response to the original request.</p> +<p>A trailers message terminates the response.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> +</dd> +<dt>Headers</dt> +<dd><p>Trailing headers sent after the response body.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_trailers message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_trailers</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.headers">gun:headers(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_up/index.html b/docs/en/gun/2.0/manual/gun_up/index.html new file mode 100644 index 00000000..3b670cc4 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_up/index.html @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_up(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_up(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_up - The connection is up</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">socks</font></tt></pre> +</div></div> +<p>The connection is up.</p> +<p>This message informs the owner process that the connection or reconnection completed.</p> +<p>If Gun is configured to connect to a Socks server, then the connection is not usable yet. One or more <a href="../gun_socks_up">gun_socks_up(3)</a> messages will follow.</p> +<p>Otherwise, Gun will start processing the messages it received while waiting for the connection to be up. If this is a reconnection, then this may not be desirable for all requests. Those requests should be cancelled when the connection goes down, and any subsequent messages ignored.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>Protocol</dt> +<dd><p>The protocol selected for this connection. It can be used to determine the capabilities of the server.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_up message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_socks_up">gun_socks_up(3)</a>, <a href="../gun_down">gun_down(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_upgrade/index.html b/docs/en/gun/2.0/manual/gun_upgrade/index.html new file mode 100644 index 00000000..36c8a660 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_upgrade/index.html @@ -0,0 +1,207 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_upgrade(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_upgrade(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_upgrade - Successful protocol upgrade</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Protocols</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Protocols</font> <font color="#990000">::</font> [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>] +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Successful protocol upgrade.</p> +<p>This message informs the relevant process that the server accepted to upgrade to one or more protocols given in the original request.</p> +<p>The exact semantics of this message depend on the original protocol. HTTP/1.1 upgrades apply to the entire connection. HTTP/2 uses a different mechanism which allows switching specific streams to a different protocol.</p> +<p>Gun currently only supports upgrading HTTP/1.1 connections to the Websocket protocol.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that resulted in an upgrade.</p> +</dd> +<dt>Protocols</dt> +<dd><p>List of protocols this stream was upgraded to.</p> +</dd> +<dt>Headers</dt> +<dd><p>Headers sent with the upgrade response.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_upgrade message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_Protocols</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/gun_ws/index.html b/docs/en/gun/2.0/manual/gun_ws/index.html new file mode 100644 index 00000000..3f070499 --- /dev/null +++ b/docs/en/gun/2.0/manual/gun_ws/index.html @@ -0,0 +1,206 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun_ws(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun_ws(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun_ws - Websocket frame</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Frame</font> <font color="#990000">::</font> <font color="#FF6600">close</font> | <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font> + | {<font color="#FF6600">text</font> | <b><font color="#000080">binary</font></b> | <font color="#FF6600">close</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">close</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">ping</font> | <font color="#FF6600">pong</font>, <b><font color="#000080">binary</font></b>()}</tt></pre> +</div></div> +<p>Websocket frame.</p> +<p>This message informs the relevant process that the server sent the enclosed frame.</p> +<p>This message can only be sent on streams that were upgraded to the Websocket protocol.</p> +<h2 id="_elements">Elements</h2> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> +</dd> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that was upgraded to Websocket.</p> +</dd> +<dt>Frame</dt> +<dd><p>The Websocket frame in question.</p> +</dd> +</dl> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: Depending on the option <code>silence_pings</code>, ping and pong frames may be sent as well. +</li> +<li><strong>1.0</strong>: Message introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Receive a gun_ws message in a gen_server</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Frame</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + diff --git a/docs/en/gun/2.0/manual/index.html b/docs/en/gun/2.0/manual/index.html new file mode 100644 index 00000000..7ba8d0db --- /dev/null +++ b/docs/en/gun/2.0/manual/index.html @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: Gun Function Reference</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=6" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>Gun Function Reference</span></h1> + +<h2 id="_name">Name</h2> +<p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p> +<h2 id="_description">Description</h2> +<p>Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.</p> +<h2 id="_modules">Modules</h2> +<ul><li><a href="gun">gun(3)</a> - Asynchronous HTTP client +</li> +</ul> +<h2 id="_dependencies">Dependencies</h2> +<ul><li><a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols +</li> +<li>ssl - Secure communication over sockets +</li> +</ul> +<p>All these applications must be started before the <code>gun</code> application. To start Gun and all dependencies at once:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_environment">Environment</h2> +<p>The <code>gun</code> application does not define any application environment configuration parameters.</p> +<h2 id="_see_also">See also</h2> +<p><a href="cowlib_app">cowlib(7)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Gun + 2.0 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/2.0/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/2.0/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/2.0/manual">2.0</a></li> + + <li><a href="/docs/en/gun/1.3/manual">1.3</a></li> + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://salt.bountysource.com/teams/ninenines">BountySource</a>. These funds are used to cover the recurring expenses like dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + |