From 24b2e92a06cf6275b972f66373d7bfea7bfc3518 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 1 Oct 2018 16:35:30 +0200 Subject: Gun 1.3.0 --- docs/en/gun/1.0/guide/connect/index.html | 2 + docs/en/gun/1.0/guide/http/index.html | 2 + docs/en/gun/1.0/guide/index.html | 2 + docs/en/gun/1.0/guide/introduction/index.html | 2 + docs/en/gun/1.0/guide/protocols/index.html | 2 + docs/en/gun/1.0/guide/start/index.html | 2 + docs/en/gun/1.0/guide/websocket/index.html | 2 + docs/en/gun/1.0/manual/gun.await/index.html | 2 + docs/en/gun/1.0/manual/gun.await_body/index.html | 2 + docs/en/gun/1.0/manual/gun.await_up/index.html | 2 + docs/en/gun/1.0/manual/gun.cancel/index.html | 2 + docs/en/gun/1.0/manual/gun.close/index.html | 2 + docs/en/gun/1.0/manual/gun.data/index.html | 2 + docs/en/gun/1.0/manual/gun.delete/index.html | 2 + docs/en/gun/1.0/manual/gun.flush/index.html | 2 + docs/en/gun/1.0/manual/gun.get/index.html | 2 + docs/en/gun/1.0/manual/gun.head/index.html | 2 + docs/en/gun/1.0/manual/gun.info/index.html | 2 + docs/en/gun/1.0/manual/gun.open/index.html | 2 + docs/en/gun/1.0/manual/gun.open_unix/index.html | 2 + docs/en/gun/1.0/manual/gun.options/index.html | 2 + docs/en/gun/1.0/manual/gun.patch/index.html | 2 + docs/en/gun/1.0/manual/gun.post/index.html | 2 + docs/en/gun/1.0/manual/gun.put/index.html | 2 + docs/en/gun/1.0/manual/gun.request/index.html | 2 + docs/en/gun/1.0/manual/gun.ws_send/index.html | 2 + docs/en/gun/1.0/manual/gun.ws_upgrade/index.html | 2 + docs/en/gun/1.0/manual/gun/index.html | 2 + docs/en/gun/1.0/manual/gun_app/index.html | 2 + docs/en/gun/1.0/manual/gun_data/index.html | 2 + docs/en/gun/1.0/manual/gun_down/index.html | 2 + docs/en/gun/1.0/manual/gun_error/index.html | 2 + docs/en/gun/1.0/manual/gun_inform/index.html | 2 + docs/en/gun/1.0/manual/gun_push/index.html | 2 + docs/en/gun/1.0/manual/gun_response/index.html | 2 + docs/en/gun/1.0/manual/gun_trailers/index.html | 2 + docs/en/gun/1.0/manual/gun_up/index.html | 2 + docs/en/gun/1.0/manual/gun_upgrade/index.html | 2 + docs/en/gun/1.0/manual/gun_ws/index.html | 2 + docs/en/gun/1.0/manual/index.html | 2 + docs/en/gun/1.1/guide/connect/index.html | 2 + docs/en/gun/1.1/guide/http/index.html | 2 + docs/en/gun/1.1/guide/index.html | 2 + docs/en/gun/1.1/guide/introduction/index.html | 2 + .../en/gun/1.1/guide/migrating_from_1.0/index.html | 2 + docs/en/gun/1.1/guide/protocols/index.html | 2 + docs/en/gun/1.1/guide/start/index.html | 2 + docs/en/gun/1.1/guide/websocket/index.html | 2 + docs/en/gun/1.1/manual/gun.await/index.html | 2 + docs/en/gun/1.1/manual/gun.await_body/index.html | 2 + docs/en/gun/1.1/manual/gun.await_up/index.html | 2 + docs/en/gun/1.1/manual/gun.cancel/index.html | 2 + docs/en/gun/1.1/manual/gun.close/index.html | 2 + docs/en/gun/1.1/manual/gun.data/index.html | 2 + docs/en/gun/1.1/manual/gun.delete/index.html | 2 + docs/en/gun/1.1/manual/gun.flush/index.html | 2 + docs/en/gun/1.1/manual/gun.get/index.html | 2 + docs/en/gun/1.1/manual/gun.head/index.html | 2 + docs/en/gun/1.1/manual/gun.info/index.html | 2 + docs/en/gun/1.1/manual/gun.open/index.html | 2 + docs/en/gun/1.1/manual/gun.open_unix/index.html | 2 + docs/en/gun/1.1/manual/gun.options/index.html | 2 + docs/en/gun/1.1/manual/gun.patch/index.html | 2 + docs/en/gun/1.1/manual/gun.post/index.html | 2 + docs/en/gun/1.1/manual/gun.put/index.html | 2 + docs/en/gun/1.1/manual/gun.request/index.html | 2 + docs/en/gun/1.1/manual/gun.ws_send/index.html | 2 + docs/en/gun/1.1/manual/gun.ws_upgrade/index.html | 2 + docs/en/gun/1.1/manual/gun/index.html | 2 + docs/en/gun/1.1/manual/gun_app/index.html | 2 + docs/en/gun/1.1/manual/gun_data/index.html | 2 + docs/en/gun/1.1/manual/gun_down/index.html | 2 + docs/en/gun/1.1/manual/gun_error/index.html | 2 + docs/en/gun/1.1/manual/gun_inform/index.html | 2 + docs/en/gun/1.1/manual/gun_push/index.html | 2 + docs/en/gun/1.1/manual/gun_response/index.html | 2 + docs/en/gun/1.1/manual/gun_trailers/index.html | 2 + docs/en/gun/1.1/manual/gun_up/index.html | 2 + docs/en/gun/1.1/manual/gun_upgrade/index.html | 2 + docs/en/gun/1.1/manual/gun_ws/index.html | 2 + docs/en/gun/1.1/manual/index.html | 2 + docs/en/gun/1.2/guide/connect/index.html | 2 + docs/en/gun/1.2/guide/http/index.html | 2 + docs/en/gun/1.2/guide/index.html | 2 + docs/en/gun/1.2/guide/introduction/index.html | 2 + .../en/gun/1.2/guide/migrating_from_1.0/index.html | 2 + .../en/gun/1.2/guide/migrating_from_1.1/index.html | 2 + docs/en/gun/1.2/guide/protocols/index.html | 2 + docs/en/gun/1.2/guide/start/index.html | 2 + docs/en/gun/1.2/guide/websocket/index.html | 2 + docs/en/gun/1.2/manual/gun.await/index.html | 2 + docs/en/gun/1.2/manual/gun.await_body/index.html | 2 + docs/en/gun/1.2/manual/gun.await_up/index.html | 2 + docs/en/gun/1.2/manual/gun.cancel/index.html | 2 + docs/en/gun/1.2/manual/gun.close/index.html | 2 + docs/en/gun/1.2/manual/gun.connect/index.html | 2 + docs/en/gun/1.2/manual/gun.data/index.html | 2 + docs/en/gun/1.2/manual/gun.delete/index.html | 2 + docs/en/gun/1.2/manual/gun.flush/index.html | 2 + docs/en/gun/1.2/manual/gun.get/index.html | 2 + docs/en/gun/1.2/manual/gun.head/index.html | 2 + docs/en/gun/1.2/manual/gun.info/index.html | 2 + docs/en/gun/1.2/manual/gun.open/index.html | 2 + docs/en/gun/1.2/manual/gun.open_unix/index.html | 2 + docs/en/gun/1.2/manual/gun.options/index.html | 2 + docs/en/gun/1.2/manual/gun.patch/index.html | 2 + docs/en/gun/1.2/manual/gun.post/index.html | 2 + docs/en/gun/1.2/manual/gun.put/index.html | 2 + docs/en/gun/1.2/manual/gun.request/index.html | 2 + docs/en/gun/1.2/manual/gun.ws_send/index.html | 2 + docs/en/gun/1.2/manual/gun.ws_upgrade/index.html | 2 + docs/en/gun/1.2/manual/gun/index.html | 2 + docs/en/gun/1.2/manual/gun_app/index.html | 2 + docs/en/gun/1.2/manual/gun_data/index.html | 2 + docs/en/gun/1.2/manual/gun_down/index.html | 2 + docs/en/gun/1.2/manual/gun_error/index.html | 2 + docs/en/gun/1.2/manual/gun_inform/index.html | 2 + docs/en/gun/1.2/manual/gun_push/index.html | 2 + docs/en/gun/1.2/manual/gun_response/index.html | 2 + docs/en/gun/1.2/manual/gun_trailers/index.html | 2 + docs/en/gun/1.2/manual/gun_up/index.html | 2 + docs/en/gun/1.2/manual/gun_upgrade/index.html | 2 + docs/en/gun/1.2/manual/gun_ws/index.html | 2 + docs/en/gun/1.2/manual/index.html | 2 + docs/en/gun/1.3/guide/connect.asciidoc | 160 +++++++ docs/en/gun/1.3/guide/connect/index.html | 258 ++++++++++ docs/en/gun/1.3/guide/gun.sty | 8 + docs/en/gun/1.3/guide/http.asciidoc | 390 +++++++++++++++ docs/en/gun/1.3/guide/http/index.html | 433 +++++++++++++++++ docs/en/gun/1.3/guide/index.html | 161 +++++++ docs/en/gun/1.3/guide/introduction.asciidoc | 52 ++ docs/en/gun/1.3/guide/introduction/index.html | 185 ++++++++ docs/en/gun/1.3/guide/migrating_from_1.0.asciidoc | 21 + .../en/gun/1.3/guide/migrating_from_1.0/index.html | 170 +++++++ docs/en/gun/1.3/guide/migrating_from_1.1.asciidoc | 28 ++ .../en/gun/1.3/guide/migrating_from_1.1/index.html | 176 +++++++ docs/en/gun/1.3/guide/migrating_from_1.2.asciidoc | 39 ++ .../en/gun/1.3/guide/migrating_from_1.2/index.html | 186 ++++++++ docs/en/gun/1.3/guide/protocols.asciidoc | 127 +++++ docs/en/gun/1.3/guide/protocols/index.html | 312 ++++++++++++ docs/en/gun/1.3/guide/start.asciidoc | 43 ++ docs/en/gun/1.3/guide/start/index.html | 191 ++++++++ docs/en/gun/1.3/guide/websocket.asciidoc | 133 ++++++ docs/en/gun/1.3/guide/websocket/index.html | 252 ++++++++++ docs/en/gun/1.3/manual/gun.await/index.html | 226 +++++++++ docs/en/gun/1.3/manual/gun.await_body/index.html | 202 ++++++++ docs/en/gun/1.3/manual/gun.await_up/index.html | 194 ++++++++ docs/en/gun/1.3/manual/gun.cancel/index.html | 180 +++++++ docs/en/gun/1.3/manual/gun.close/index.html | 172 +++++++ docs/en/gun/1.3/manual/gun.connect/index.html | 233 +++++++++ docs/en/gun/1.3/manual/gun.data/index.html | 191 ++++++++ docs/en/gun/1.3/manual/gun.delete/index.html | 200 ++++++++ docs/en/gun/1.3/manual/gun.flush/index.html | 185 ++++++++ docs/en/gun/1.3/manual/gun.get/index.html | 203 ++++++++ docs/en/gun/1.3/manual/gun.head/index.html | 205 ++++++++ docs/en/gun/1.3/manual/gun.info/index.html | 191 ++++++++ docs/en/gun/1.3/manual/gun.open/index.html | 196 ++++++++ docs/en/gun/1.3/manual/gun.open_unix/index.html | 184 ++++++++ docs/en/gun/1.3/manual/gun.options/index.html | 200 ++++++++ docs/en/gun/1.3/manual/gun.patch/index.html | 223 +++++++++ docs/en/gun/1.3/manual/gun.post/index.html | 221 +++++++++ docs/en/gun/1.3/manual/gun.put/index.html | 221 +++++++++ docs/en/gun/1.3/manual/gun.request/index.html | 207 ++++++++ docs/en/gun/1.3/manual/gun.ws_send/index.html | 189 ++++++++ docs/en/gun/1.3/manual/gun.ws_upgrade/index.html | 213 +++++++++ docs/en/gun/1.3/manual/gun/index.html | 405 ++++++++++++++++ docs/en/gun/1.3/manual/gun_app/index.html | 165 +++++++ docs/en/gun/1.3/manual/gun_data/index.html | 189 ++++++++ docs/en/gun/1.3/manual/gun_down/index.html | 195 ++++++++ docs/en/gun/1.3/manual/gun_error/index.html | 188 ++++++++ docs/en/gun/1.3/manual/gun_inform/index.html | 188 ++++++++ docs/en/gun/1.3/manual/gun_push/index.html | 208 ++++++++ docs/en/gun/1.3/manual/gun_response/index.html | 191 ++++++++ docs/en/gun/1.3/manual/gun_trailers/index.html | 183 +++++++ docs/en/gun/1.3/manual/gun_up/index.html | 179 +++++++ docs/en/gun/1.3/manual/gun_upgrade/index.html | 189 ++++++++ docs/en/gun/1.3/manual/gun_ws/index.html | 185 ++++++++ docs/en/gun/1.3/manual/index.html | 165 +++++++ docs/index.html | 7 + docs/index.xml | 524 +++++++++++++++++++++ 180 files changed, 10970 insertions(+) create mode 100644 docs/en/gun/1.3/guide/connect.asciidoc create mode 100644 docs/en/gun/1.3/guide/connect/index.html create mode 100644 docs/en/gun/1.3/guide/gun.sty create mode 100644 docs/en/gun/1.3/guide/http.asciidoc create mode 100644 docs/en/gun/1.3/guide/http/index.html create mode 100644 docs/en/gun/1.3/guide/index.html create mode 100644 docs/en/gun/1.3/guide/introduction.asciidoc create mode 100644 docs/en/gun/1.3/guide/introduction/index.html create mode 100644 docs/en/gun/1.3/guide/migrating_from_1.0.asciidoc create mode 100644 docs/en/gun/1.3/guide/migrating_from_1.0/index.html create mode 100644 docs/en/gun/1.3/guide/migrating_from_1.1.asciidoc create mode 100644 docs/en/gun/1.3/guide/migrating_from_1.1/index.html create mode 100644 docs/en/gun/1.3/guide/migrating_from_1.2.asciidoc create mode 100644 docs/en/gun/1.3/guide/migrating_from_1.2/index.html create mode 100644 docs/en/gun/1.3/guide/protocols.asciidoc create mode 100644 docs/en/gun/1.3/guide/protocols/index.html create mode 100644 docs/en/gun/1.3/guide/start.asciidoc create mode 100644 docs/en/gun/1.3/guide/start/index.html create mode 100644 docs/en/gun/1.3/guide/websocket.asciidoc create mode 100644 docs/en/gun/1.3/guide/websocket/index.html create mode 100644 docs/en/gun/1.3/manual/gun.await/index.html create mode 100644 docs/en/gun/1.3/manual/gun.await_body/index.html create mode 100644 docs/en/gun/1.3/manual/gun.await_up/index.html create mode 100644 docs/en/gun/1.3/manual/gun.cancel/index.html create mode 100644 docs/en/gun/1.3/manual/gun.close/index.html create mode 100644 docs/en/gun/1.3/manual/gun.connect/index.html create mode 100644 docs/en/gun/1.3/manual/gun.data/index.html create mode 100644 docs/en/gun/1.3/manual/gun.delete/index.html create mode 100644 docs/en/gun/1.3/manual/gun.flush/index.html create mode 100644 docs/en/gun/1.3/manual/gun.get/index.html create mode 100644 docs/en/gun/1.3/manual/gun.head/index.html create mode 100644 docs/en/gun/1.3/manual/gun.info/index.html create mode 100644 docs/en/gun/1.3/manual/gun.open/index.html create mode 100644 docs/en/gun/1.3/manual/gun.open_unix/index.html create mode 100644 docs/en/gun/1.3/manual/gun.options/index.html create mode 100644 docs/en/gun/1.3/manual/gun.patch/index.html create mode 100644 docs/en/gun/1.3/manual/gun.post/index.html create mode 100644 docs/en/gun/1.3/manual/gun.put/index.html create mode 100644 docs/en/gun/1.3/manual/gun.request/index.html create mode 100644 docs/en/gun/1.3/manual/gun.ws_send/index.html create mode 100644 docs/en/gun/1.3/manual/gun.ws_upgrade/index.html create mode 100644 docs/en/gun/1.3/manual/gun/index.html create mode 100644 docs/en/gun/1.3/manual/gun_app/index.html create mode 100644 docs/en/gun/1.3/manual/gun_data/index.html create mode 100644 docs/en/gun/1.3/manual/gun_down/index.html create mode 100644 docs/en/gun/1.3/manual/gun_error/index.html create mode 100644 docs/en/gun/1.3/manual/gun_inform/index.html create mode 100644 docs/en/gun/1.3/manual/gun_push/index.html create mode 100644 docs/en/gun/1.3/manual/gun_response/index.html create mode 100644 docs/en/gun/1.3/manual/gun_trailers/index.html create mode 100644 docs/en/gun/1.3/manual/gun_up/index.html create mode 100644 docs/en/gun/1.3/manual/gun_upgrade/index.html create mode 100644 docs/en/gun/1.3/manual/gun_ws/index.html create mode 100644 docs/en/gun/1.3/manual/index.html (limited to 'docs') diff --git a/docs/en/gun/1.0/guide/connect/index.html b/docs/en/gun/1.0/guide/connect/index.html index 8930838d..8c2c2d0f 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/guide/http/index.html b/docs/en/gun/1.0/guide/http/index.html index 204b19ff..d1bd11e4 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/guide/index.html b/docs/en/gun/1.0/guide/index.html index 6e5b333c..c93a5883 100644 --- a/docs/en/gun/1.0/guide/index.html +++ b/docs/en/gun/1.0/guide/index.html @@ -110,6 +110,8 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/guide/introduction/index.html b/docs/en/gun/1.0/guide/introduction/index.html index e9f8f2dd..25701ec1 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. +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/guide/protocols/index.html b/docs/en/gun/1.0/guide/protocols/index.html index 36db85ae..a4696060 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 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/guide/start/index.html b/docs/en/gun/1.0/guide/start/index.html index f8a5e8fc..64cef578 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/guide/websocket/index.html b/docs/en/gun/1.0/guide/websocket/index.html index 7b5ea381..a3f4593f 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 e4f096c4..90f122dd 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f2aa458f..f0fb30ef 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 95f77846..ef5a6306 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 0833f57b..74163c1a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 c24b3e56..30150a08 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 8a41e054..142bee5a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f468b755..148af99a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 4f6f624b..6024ee40 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 cbe1ad0b..5245678a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 87cbfd37..2c86f9f2 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 e16880fe..07783401 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 a10ca71a..657f27f2 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 eb3c26b2..0d652da0 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f1b904e1..08b92323 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 63d1f7cb..b395ac49 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 53627024..354e0468 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 4d689f79..5c848601 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 cdce7a36..5f935e14 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 77f54399..9f1c79d5 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 60e364c3..aa130060 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/manual/gun/index.html b/docs/en/gun/1.0/manual/gun/index.html index 75ad3819..2b8c695c 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 301da7c4..5d7f2f41 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 e4510042..1a01fc59 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 8e7119c4..1f744b2d 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 79d20f08..c46cd8d4 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 7d2f951c..f42f3dc0 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 bb8da989..4a9a871c 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 4b8556a2..ce04a9ee 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 4410603b..6d01d6c4 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 8111dfbd..68a74ae9 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 44d06e69..57737456 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 66b77f0b..e8cdafb5 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.0/manual/index.html b/docs/en/gun/1.0/manual/index.html index 44d87877..6e22b899 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/guide/connect/index.html b/docs/en/gun/1.1/guide/connect/index.html index 1808e795..4195a5c8 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/guide/http/index.html b/docs/en/gun/1.1/guide/http/index.html index 86a56309..37b9bf22 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/guide/index.html b/docs/en/gun/1.1/guide/index.html index 0ead6e43..0487f15a 100644 --- a/docs/en/gun/1.1/guide/index.html +++ b/docs/en/gun/1.1/guide/index.html @@ -115,6 +115,8 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/guide/introduction/index.html b/docs/en/gun/1.1/guide/introduction/index.html index 40b7f174..ad667eb8 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. +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 ab21e441..d3b008bd 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 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/guide/protocols/index.html b/docs/en/gun/1.1/guide/protocols/index.html index d2852ee4..3f488078 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 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/guide/start/index.html b/docs/en/gun/1.1/guide/start/index.html index 2ffccf2d..54a89f20 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/guide/websocket/index.html b/docs/en/gun/1.1/guide/websocket/index.html index c17f0f89..59f911f6 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f3fecc72..45c0392e 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 5046d8d6..aa5dad21 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 b1cd8bca..0e70c7a7 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 fd69bffe..0968e81f 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 98277c77..f3ad6db2 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 0ec6792d..5e8a163a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 17e92654..a134ae44 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 97e80056..7dab6b99 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 00c9039c..ff186dd6 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 8ab2a102..28f0949c 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 0ecd9c50..fd62fac9 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 241eb95e..2e00d2be 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 afc4852e..73a5200b 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 29c036e5..19210a64 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 397e1514..76de6cd7 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 5b981f44..833d1140 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 cdf5beba..ffac688b 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 ec7ecaa6..6c592e22 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f8656645..fbcd560a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 70692794..1d743d4f 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/manual/gun/index.html b/docs/en/gun/1.1/manual/gun/index.html index dabe7a9e..02d0ee10 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 3d6bbe51..ecaac199 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 897a6925..be10c68a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 b0884907..f6a0f1f2 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 9cad2af2..4afa0941 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 d8e80e29..2b61af19 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 6bd6f7ee..61b8153e 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 8ad25765..3a4f722b 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 94c7ecdb..49cf2225 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 c1a6c752..41038f6b 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 2ba35bf5..09284d78 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 a6f91b80..43674d0c 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.1/manual/index.html b/docs/en/gun/1.1/manual/index.html index 6cd9c248..ce3925ee 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/guide/connect/index.html b/docs/en/gun/1.2/guide/connect/index.html index 5b748726..9ff61ca0 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/guide/http/index.html b/docs/en/gun/1.2/guide/http/index.html index 63c71725..c2d3828f 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/guide/index.html b/docs/en/gun/1.2/guide/index.html index 2b43b752..a9f652c8 100644 --- a/docs/en/gun/1.2/guide/index.html +++ b/docs/en/gun/1.2/guide/index.html @@ -117,6 +117,8 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/guide/introduction/index.html b/docs/en/gun/1.2/guide/introduction/index.html index f5558b24..8ed554e9 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. +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 96f43341..02a55aa9 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 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 d69ad239..b6783fd4 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 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/guide/protocols/index.html b/docs/en/gun/1.2/guide/protocols/index.html index f48b0a5a..9b4c52c0 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 @@ +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/guide/start/index.html b/docs/en/gun/1.2/guide/start/index.html index 6388c204..cac3192c 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/guide/websocket/index.html b/docs/en/gun/1.2/guide/websocket/index.html index 189fcf44..15091dc6 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 fa887576..cd74b30b 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 08af0b36..cb4f71d6 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f19345ac..08fa1072 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 4ed0dd11..f892bac9 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 ed7bb667..600d0acd 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 b8fba81f..cf40257d 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 1aead1f3..a235fc9f 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 c6034ac6..dadd1d2b 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 c9f0c895..e066ded3 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 b438ec66..1bb31ba5 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 08ae2464..84541ab8 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 4518add7..db8946c0 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f8bf4d98..b8a0c233 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 d126d75c..26850f92 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 e883e2ab..b292ba47 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 a7a70c67..f2451dc6 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 080bee32..fbdf0e12 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 bbdd0c75..a3c46238 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 185043ee..621fbefb 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 6d31659b..767537e5 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 f2a5589c..2a1ac9f0 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/manual/gun/index.html b/docs/en/gun/1.2/manual/gun/index.html index ea394fc1..bb77912c 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 6ec8ad7b..d94e851b 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 43ac5bd3..6c815a84 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 a180670b..f25b9e6a 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 3eb54a5f..a123c153 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 7524de76..9366126c 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 12d552b9..83476c31 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 6a7140b9..705e75ff 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 117ff514..43157ea3 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 81389314..27280d1e 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 745983b2..ad19220f 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • 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 dec115a7..ff4d68ff 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.2/manual/index.html b/docs/en/gun/1.2/manual/index.html index 311b0850..eb442678 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 --> +
  • 1.3
    • +
  • 1.2
  • 1.1
    • diff --git a/docs/en/gun/1.3/guide/connect.asciidoc b/docs/en/gun/1.3/guide/connect.asciidoc new file mode 100644 index 00000000..dd4297d1 --- /dev/null +++ b/docs/en/gun/1.3/guide/connect.asciidoc @@ -0,0 +1,160 @@ +[[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. + +The owner process communicates 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 owner 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}). +---- + +=== 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/1.3/guide/connect/index.html b/docs/en/gun/1.3/guide/connect/index.html new file mode 100644 index 00000000..26d31ae1 --- /dev/null +++ b/docs/en/gun/1.3/guide/connect/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + Nine Nines: Connection + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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.

    +

    The owner process communicates 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 owner 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
    +
    +
    {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
    +
    +
    {ok, ConnPid} = gun:open("example.org", 8443, #{transport => tls}).
    +
    +

    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
    +
    +
    {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
    +
    +
    {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
    +
    +
    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
    +
    +
    gun:close(ConnPid).
    +
    +

    The process is stopped immediately without having a chance to perform the protocol's closing handshake, if any.

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

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/gun.sty b/docs/en/gun/1.3/guide/gun.sty new file mode 100644 index 00000000..d5e0d3be --- /dev/null +++ b/docs/en/gun/1.3/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/1.3/guide/http.asciidoc b/docs/en/gun/1.3/guide/http.asciidoc new file mode 100644 index 00000000..652030a3 --- /dev/null +++ b/docs/en/gun/1.3/guide/http.asciidoc @@ -0,0 +1,390 @@ +[[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 owner 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 `gun:post/4,5`, `gun:put/4,5` and `gun:patch/4,5` functions +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 `gun:post/3`, `gun:put/3` and `gun:patch/3` functions +do not take a body in their arguments. If a body is to be +provided later on, using the `gun:data/4` function, then +the request headers must indicate this. This can be done +by setting the content-length or content-type request +headers. If these headers are not set then Gun will assume +the request has no body. + +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 `gun:request/4,5,6` function 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 owner +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/1.3/guide/http/index.html b/docs/en/gun/1.3/guide/http/index.html new file mode 100644 index 00000000..c88fa35b --- /dev/null +++ b/docs/en/gun/1.3/guide/http/index.html @@ -0,0 +1,433 @@ + + + + + + + + + + Nine Nines: HTTP + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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 owner 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
    +
    +
    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"
    +
    +
    StreamRef = gun:get(ConnPid, "/organizations/ninenines").
    +
    +
    GET "/organizations/ninenines" with custom headers
    +
    +
    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"
    +
    +
    StreamRef = gun:head(ConnPid, "/organizations/ninenines").
    +
    +
    HEAD "/organizations/ninenines" with custom headers
    +
    +
    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 gun:post/4,5, gun:put/4,5 and gun:patch/4,5 functions 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"
    +
    +
    Body = "{\"msg\": \"Hello world!\"}",
+StreamRef = gun:post(ConnPid, "/organizations/ninenines", [
+    {<<"content-type">>, "application/json"}
+], Body).
    +
    +

    The gun:post/3, gun:put/3 and gun:patch/3 functions do not take a body in their arguments. If a body is to be provided later on, using the gun:data/4 function, then the request headers must indicate this. This can be done by setting the content-length or content-type request headers. If these headers are not set then Gun will assume the request has no body.

    +

    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
    +
    +
    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
    +
    +
    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"
    +
    +
    StreamRef = gun:delete(ConnPid, "/organizations/ninenines").
    +
    +
    DELETE "/organizations/ninenines" with custom headers
    +
    +
    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"
    +
    +
    StreamRef = gun:options(ConnPid, "/organizations/ninenines").
    +
    +
    OPTIONS "/organizations/ninenines" with custom headers
    +
    +
    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 "*"
    +
    +
    StreamRef = gun:options(ConnPid, "*").
    +
    +

    Requests with an arbitrary method

    +

    The gun:request/4,5,6 function 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
    +
    +
    gun:request(ConnPid, "TRACE", "/", [
+    {<<"max-forwards">>, "30"}
+]).
    +
    +

    Processing responses

    +

    All data received from the server is sent to the owner 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
    +
    +
    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
    +
    +
    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
    +
    +
    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
    +
    +
    {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
    +
    +
    gun:flush(ConnPid).
    +
    +
    Flush all messages from a specific stream
    +
    +
    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
    +
    +
    StreamRef = gun:get(ConnPid, "/organizations/ninenines", [],
+    #{reply_to => Pid}).
    +
    + + + + + + + + + + + + + + + + +
    + +
    + + +

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/index.html b/docs/en/gun/1.3/guide/index.html new file mode 100644 index 00000000..676051aa --- /dev/null +++ b/docs/en/gun/1.3/guide/index.html @@ -0,0 +1,161 @@ + + + + + + + + + + Nine Nines: Gun User Guide + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/introduction.asciidoc b/docs/en/gun/1.3/guide/introduction.asciidoc new file mode 100644 index 00000000..f7cd9c10 --- /dev/null +++ b/docs/en/gun/1.3/guide/introduction.asciidoc @@ -0,0 +1,52 @@ +[[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 19.0 and newer. + +=== License + +Gun uses the ISC License. + +---- +Copyright (c) 2013-2018, Loïc Hoguin + +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, and expects your application to provide lowercase header +names. + +The same applies to any other case insensitive value. diff --git a/docs/en/gun/1.3/guide/introduction/index.html b/docs/en/gun/1.3/guide/introduction/index.html new file mode 100644 index 00000000..6ddd41ac --- /dev/null +++ b/docs/en/gun/1.3/guide/introduction/index.html @@ -0,0 +1,185 @@ + + + + + + + + + + Nine Nines: Introduction + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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 19.0 and newer.

    +

    License

    +

    Gun uses the ISC License.

    +
    Copyright (c) 2013-2018, Loïc Hoguin <essen@ninenines.eu>
+
+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 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, and expects your application to provide lowercase header names.

    +

    The same applies to any other case insensitive value.

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

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/migrating_from_1.0.asciidoc b/docs/en/gun/1.3/guide/migrating_from_1.0.asciidoc new file mode 100644 index 00000000..8057683c --- /dev/null +++ b/docs/en/gun/1.3/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/1.3/guide/migrating_from_1.0/index.html b/docs/en/gun/1.3/guide/migrating_from_1.0/index.html new file mode 100644 index 00000000..1644ca7b --- /dev/null +++ b/docs/en/gun/1.3/guide/migrating_from_1.0/index.html @@ -0,0 +1,170 @@ + + + + + + + + + + Nine Nines: Migrating from Gun 1.0 to 1.1 + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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. +
      • +
    + + + + + + + + + + + + + + + + +
    + +
    + + +

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/migrating_from_1.1.asciidoc b/docs/en/gun/1.3/guide/migrating_from_1.1.asciidoc new file mode 100644 index 00000000..bc2097f9 --- /dev/null +++ b/docs/en/gun/1.3/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/1.3/guide/migrating_from_1.1/index.html b/docs/en/gun/1.3/guide/migrating_from_1.1/index.html new file mode 100644 index 00000000..85953460 --- /dev/null +++ b/docs/en/gun/1.3/guide/migrating_from_1.1/index.html @@ -0,0 +1,176 @@ + + + + + + + + + + Nine Nines: Migrating from Gun 1.1 to 1.2 + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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. +
      • +
    + + + + + + + + + + + + + + + + +
    + +
    + + +

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/migrating_from_1.2.asciidoc b/docs/en/gun/1.3/guide/migrating_from_1.2.asciidoc new file mode 100644 index 00000000..a870858e --- /dev/null +++ b/docs/en/gun/1.3/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/1.3/guide/migrating_from_1.2/index.html b/docs/en/gun/1.3/guide/migrating_from_1.2/index.html new file mode 100644 index 00000000..94f5ed47 --- /dev/null +++ b/docs/en/gun/1.3/guide/migrating_from_1.2/index.html @@ -0,0 +1,186 @@ + + + + + + + + + + Nine Nines: Migrating from Gun 1.2 to 1.3 + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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. +
      • +
    + + + + + + + + + + + + + + + + +
    + +
    + + +

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/protocols.asciidoc b/docs/en/gun/1.3/guide/protocols.asciidoc new file mode 100644 index 00000000..2c4fd10e --- /dev/null +++ b/docs/en/gun/1.3/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:request/4,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/1.3/guide/protocols/index.html b/docs/en/gun/1.3/guide/protocols/index.html new file mode 100644 index 00000000..97571a3d --- /dev/null +++ b/docs/en/gun/1.3/guide/protocols/index.html @@ -0,0 +1,312 @@ + + + + + + + + + + Nine Nines: Supported protocols + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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:request/4,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
    OperationHTTP/1.1HTTP/2Websocket
    deleteyesyesno
    getyesyesno
    headyesyesno
    optionsyesyesno
    patchyesyesno
    postyesyesno
    putyesyesno
    requestyesyesno
    datayesyesno
    awaityesyesno
    await_bodyyesyesno
    flushyesyesno
    cancelyesyesno
    ws_upgradeyesnono
    ws_sendnonoyes
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Messages sent per protocol
    MessageHTTP/1.1HTTP/2Websocket
    gun_pushnoyesno
    gun_informyesyesno
    gun_responseyesyesno
    gun_datayesyesno
    gun_trailersyesyesno
    gun_erroryesyesyes
    gun_upgradeyesnono
    gun_wsnonoyes
    + + + + + + + + + + + + + + + + +
    + +
    + + +

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/start.asciidoc b/docs/en/gun/1.3/guide/start.asciidoc new file mode 100644 index 00000000..09720dca --- /dev/null +++ b/docs/en/gun/1.3/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/1.3/guide/start/index.html b/docs/en/gun/1.3/guide/start/index.html new file mode 100644 index 00000000..644c634a --- /dev/null +++ b/docs/en/gun/1.3/guide/start/index.html @@ -0,0 +1,191 @@ + + + + + + + + + + Nine Nines: Starting and stopping + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    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
    +
    +
    DEPS = gun
    +
    +

    Starting

    +

    Gun is an OTP application. It needs to be started before you can use it.

    +
    Starting Gun in an Erlang shell
    +
    +
    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
    +
    +
    application:stop(gun).
    +
    + + + + + + + + + + + + + + + + +
    + +
    + + +

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/guide/websocket.asciidoc b/docs/en/gun/1.3/guide/websocket.asciidoc new file mode 100644 index 00000000..85036700 --- /dev/null +++ b/docs/en/gun/1.3/guide/websocket.asciidoc @@ -0,0 +1,133 @@ +[[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!"}). +---- + +// @todo Implement sending of N frames +// +//.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 will attempt to reconnect afterwards. + +=== 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. +---- + +// @todo auto ping has not been implemented yet +// +//Gun will automatically send ping messages to the server to keep +//the connection alive, however if the connection dies and Gun has +//to reconnect it will not upgrade to Websocket automatically, you +//need to perform the operation when you receive the `gun_error` +//message. diff --git a/docs/en/gun/1.3/guide/websocket/index.html b/docs/en/gun/1.3/guide/websocket/index.html new file mode 100644 index 00000000..c5cb1211 --- /dev/null +++ b/docs/en/gun/1.3/guide/websocket/index.html @@ -0,0 +1,252 @@ + + + + + + + + + + Nine Nines: Websocket + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    Websocket

    + +

    This chapter describes how to use the Gun client for communicating with a Websocket server.

    + +

    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
    +
    +
    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
    +
    +
    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
    +
    +
    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:

    +
    +
    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
    +
    +
    gun:ws_send(ConnPid, {text, "Hello!"}).
    +
    + + + + + + + + + + + +

    Note that if you send a close frame, Gun will close the connection cleanly but will attempt to reconnect afterwards.

    +

    Receiving data

    +

    Gun sends an Erlang message to the owner process for every Websocket message it receives.

    +
    +
    receive
+    {gun_ws, ConnPid, StreamRef, Frame} ->
+        handle_frame(ConnPid, StreamRef, Frame)
+end.
    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + +

    + Gun + 1.3 + + User Guide +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.await/index.html b/docs/en/gun/1.3/manual/gun.await/index.html new file mode 100644 index 00000000..805b6d22 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.await/index.html @@ -0,0 +1,226 @@ + + + + + + + + + + Nine Nines: gun:await(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:await(3)

    + +

    Name

    +

    gun:await - Wait for a response

    +

    Description

    +
    +
    await(ConnPid, StreamRef)
+    -> await(ConnPid, StreamRef, 5000, MonitorRef)
+
+await(ConnPid, StreamRef, MonitorRef)
+    -> await(ConnPid, StreamRef, 5000, MonitorRef)
+
+await(ConnPid, StreamRef, Timeout)
+    -> await(ConnPid, StreamRef, Timeout, MonitorRef)
+
+await(ConnPid, StreamRef, Timeout, MonitorRef)
+    -> Result
+
+ConnPid    :: pid()
+StreamRef  :: reference()
+MonitorRef :: reference()
+Timeout    :: timeout()
+Result     :: tuple() - see below
    +
    +

    Wait for a response.

    +

    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.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    Timeout
    +

    How long to wait for a message, in milliseconds.

    +
    +
    MonitorRef
    +

    Monitor for the Gun connection process.

    +

    A monitor is automatically created for the duration of this call when one is not provided.

    +
    +
    +

    Return value

    +

    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.

    +
    +
    Result :: {inform, Status, Headers}
+          {response, IsFin, Status, Headers}
+          {data, IsFin, Data}
+          {trailers, Trailers}
+          {push, NewStreamRef, Method, URI, Headers}
+          {error, Reason}
+
+Reason :: timeout | any()
    +
    +

    Because the messages and returned tuples are equivalent, please refer to the manual pages for each message for further information:

    + +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Wait for a response
    +
    +
    StreamRef = gun:get(ConnPid, "/articles", [
+    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
+]).
+{response, nofin, 200, _Headers} = gun:await(ConnPid, StreamRef).
+{data, fin, <<"Hello world!">>} = gun:await(ConnPid, StreamRef).
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:head(3), gun:options(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:request(3), gun:await_body(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + 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 new file mode 100644 index 00000000..cb45e759 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.await_body/index.html @@ -0,0 +1,202 @@ + + + + + + + + + + Nine Nines: gun:await_body(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:await_body(3)

    + +

    Name

    +

    gun:await_body - Wait for the complete response body

    +

    Description

    +
    +
    await_body(ConnPid, StreamRef)
+    -> await_body(ConnPid, StreamRef, 5000, MonitorRef)
+
+await_body(ConnPid, StreamRef, MonitorRef)
+    -> await_body(ConnPid, StreamRef, 5000, MonitorRef)
+
+await_body(ConnPid, StreamRef, Timeout)
+    -> await_body(ConnPid, StreamRef, Timeout, MonitorRef)
+
+await_body(ConnPid, StreamRef, Timeout, MonitorRef)
+    -> {ok, Body} | {ok, Body, Trailers} | {error, Reason}
+
+ConnPid    :: pid()
+StreamRef  :: reference()
+MonitorRef :: reference()
+Timeout    :: timeout()
+Body       :: binary()
+Trailers   :: [{binary(), binary()}]
+Reason     :: timeout | any()
    +
    +

    Wait for the complete response body.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    Timeout
    +

    How long to wait for each message, in milliseconds.

    +
    +
    MonitorRef
    +

    Monitor for the Gun connection process.

    +

    A monitor is automatically created for the duration of this call when one is not provided.

    +
    +
    +

    Return value

    +

    The body is returned, possibly with trailers if the request contained a te: trailers header. Error tuples may also be returned when a timeout or an error occur.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Wait for the complete response body
    +
    +
    StreamRef = gun:get(ConnPid, "/articles", [
+    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
+]).
+{response, nofin, 200, _Headers} = gun:await(ConnPid, StreamRef).
+{ok, _Body} = gun:await_body(ConnPid, StreamRef).
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:head(3), gun:options(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:request(3), gun:await(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + 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 new file mode 100644 index 00000000..489a2779 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.await_up/index.html @@ -0,0 +1,194 @@ + + + + + + + + + + Nine Nines: gun:await_up(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:await_up(3)

    + +

    Name

    +

    gun:await_up - Wait for the connection to be up

    +

    Description

    +
    +
    await_up(ConnPid)
+    -> await_up(ConnPid, 5000, MonitorRef)
+
+await_up(ConnPid, MonitorRef)
+    -> await_up(ConnPid, 5000, MonitorRef)
+
+await_up(ConnPid, Timeout)
+    -> await_up(ConnPid, Timeout, MonitorRef)
+
+await_up(ConnPid, Timeout, MonitorRef)
+    -> {ok, Protocol} | {error, Reason}
+
+ConnPid    :: pid()
+MonitorRef :: reference()
+Timeout    :: timeout()
+Protocol   :: http | http2
+Reason     :: timeout | any()
    +
    +

    Wait for the connection to be up.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Timeout
    +

    How long to wait for, in milliseconds.

    +
    +
    MonitorRef
    +

    Monitor for the Gun connection process.

    +

    A monitor is automatically created for the duration of this call when one is not provided.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Wait for the connection to be up
    +
    +
    {ok, ConnPid} = gun:open("example.org", 443).
+{ok, _} = gun:await_up(ConnPid).
    +
    +

    See also

    +

    gun(3), gun:open(3), gun:open_unix(3), gun_up(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.cancel/index.html b/docs/en/gun/1.3/manual/gun.cancel/index.html new file mode 100644 index 00000000..e54e19f8 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.cancel/index.html @@ -0,0 +1,180 @@ + + + + + + + + + + Nine Nines: gun:cancel(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:cancel(3)

    + +

    Name

    +

    gun:cancel - Cancel the given stream

    +

    Description

    +
    +
    cancel(ConnPid, StreamRef) -> ok
+
+ConnPid   :: pid()
+StreamRef :: reference()
    +
    +

    Cancel the given stream.

    +

    The behavior of this function depends on the protocol selected.

    +

    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.

    +

    HTTP/2 allows cancelling streams at any time.

    +

    This function is asynchronous. Messages related to this stream may still be sent after the function returns.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    +

    Return value

    +

    The atom ok is returned.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Cancel a stream
    +
    +
    gun:cancel(ConnPid, StreamRef).
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:head(3), gun:options(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:request(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.close/index.html b/docs/en/gun/1.3/manual/gun.close/index.html new file mode 100644 index 00000000..863a0092 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.close/index.html @@ -0,0 +1,172 @@ + + + + + + + + + + Nine Nines: gun:close(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:close(3)

    + +

    Name

    +

    gun:close - Brutally close the connection

    +

    Description

    +
    +
    close(ConnPid) -> ok
+
+ConnPid :: pid()
    +
    +

    Brutally close the connection.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    +

    Return value

    +

    The atom ok is returned.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Close the connection
    +
    +
    ok = gun:close(ConnPid).
    +
    +

    See also

    +

    gun(3), gun:open(3), gun:open_unix(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.connect/index.html b/docs/en/gun/1.3/manual/gun.connect/index.html new file mode 100644 index 00000000..134a32da --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.connect/index.html @@ -0,0 +1,233 @@ + + + + + + + + + + Nine Nines: gun:connect(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:connect(3)

    + +

    Name

    +

    gun:connect - Establish a tunnel to the origin server

    +

    Description

    +
    +
    connect(ConnPid, Destination)
+    -> connect(ConnPid, Destination, [], #{}).
+
+connect(ConnPid, Destination, Headers)
+    -> connect(ConnPid, Destination, Headers, #{}).
+
+connect(ConnPid, Destination, Headers, ReqOpts)
+    -> StreamRef
+
+ConnPid     :: pid()
+Destination :: gun:connect_destination()
+Headers     :: [{binary(), iodata()}]
+ReqOpts     :: gun:req_opts()
+StreamRef   :: reference()
    +
    +

    Establish a tunnel to the origin server.

    +

    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.

    +

    Gun will not automatically re-issue the CONNECT request upon reconnection to the proxy server. The gun_up message can be used to know when the tunnel needs to be established again.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Destination
    +

    Destination of the CONNECT request.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.2: Function introduced. +
      • +
    +

    Examples

    +
    Establish a tunnel
    +
    +
    {ok, ConnPid} = gun:open("proxy.example.org", 1080),
+{ok, http} = gun:await_up(ConnPid),
+StreamRef = gun:connect(ConnPid, #{
+    host => "origin-server.example.org",
+    port => 80
+}),
+{response, fin, 200, _} = gun:await(ConnPid, StreamRef),
+%% Subsequent requests will be sent to origin-server.example.org.
    +
    +
    Establish a tunnel for a secure HTTP/2 connection
    +
    +
    {ok, ConnPid} = gun:open("proxy.example.org", 1080),
+{ok, http} = gun:await_up(ConnPid),
+StreamRef = gun:connect(ConnPid, #{
+    host => "origin-server.example.org",
+    port => 443,
+    protocols => [http2],
+    transport => tls
+}),
+{response, fin, 200, _} = gun:await(ConnPid, StreamRef),
+%% Subsequent requests will be sent to origin-server.example.org.
    +
    +
    Establish a tunnel using proxy authorization
    +
    +
    {ok, ConnPid} = gun:open("proxy.example.org", 1080),
+{ok, http} = gun:await_up(ConnPid),
+StreamRef = gun:connect(ConnPid, #{
+    host => "origin-server.example.org",
+    port => 80,
+    username => "essen",
+    password => "myrealpasswordis"
+}),
+{response, fin, 200, _} = gun:await(ConnPid, StreamRef),
+%% Subsequent requests will be sent to origin-server.example.org.
    +
    +

    See also

    +

    gun(3), gun:await_up(3), gun_up(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.data/index.html b/docs/en/gun/1.3/manual/gun.data/index.html new file mode 100644 index 00000000..e4592adf --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.data/index.html @@ -0,0 +1,191 @@ + + + + + + + + + + Nine Nines: gun:data(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:data(3)

    + +

    Name

    +

    gun:data - Stream the body of a request

    +

    Description

    +
    +
    data(ConnPid, StreamRef, IsFin, Data) -> ok
+
+ConnPid   :: pid()
+StreamRef :: reference()
+IsFin     :: fin | nofin
+Data      :: iodata()
    +
    +

    Stream the body of a request.

    +

    This function can only be used if the original request had headers indicating that a body would be streamed.

    +

    All calls to this function must use the nofin flag except for the last which must use fin to indicate the end of the request body.

    +

    Empty data is allowed regardless of the value of IsFin. Gun may or may not send empty data chunks, however.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    IsFin
    +

    Whether this message terminates the request.

    +
    +
    Data
    +

    All or part of the response body.

    +
    +
    +

    Return value

    +

    The atom ok is returned.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Stream the body of a request
    +
    +
    StreamRef = gun:put(ConnPid, "/lang/fr_FR/hello", [
+    {<<"content-type">>, <<"text/plain">>}
+]).
+gun:data(ConnPid, StreamRef, nofin, <<"Bonjour !\n">>).
+gun:data(ConnPid, StreamRef, fin, <<"Bonsoir !\n">>).
    +
    +

    See also

    +

    gun(3), gun:patch(3), gun:post(3), gun:put(3), gun:request(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.delete/index.html b/docs/en/gun/1.3/manual/gun.delete/index.html new file mode 100644 index 00000000..25b17ce3 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.delete/index.html @@ -0,0 +1,200 @@ + + + + + + + + + + Nine Nines: gun:delete(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:delete(3)

    + +

    Name

    +

    gun:delete - Delete a resource

    +

    Description

    +
    +
    delete(ConnPid, Path)
+    -> delete(ConnPid, Path, [], #{}).
+
+delete(ConnPid, Path, Headers)
+    -> delete(ConnPid, Path, Headers, #{})
+
+delete(ConnPid, Path, Headers, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Delete a resource.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Delete a resource
    +
    +
    StreamRef = gun:delete(ConnPid, "/drafts/123").
    +
    +
    Delete a resource with request options
    +
    +
    StreamRef = gun:delete(ConnPid, "/drafts/123", [],
+    #{reply_to => ReplyToPid}).
    +
    +

    See also

    +

    gun(3), gun:put(3), gun:await(3), gun:await_body(3), gun_push(3), gun_inform(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.flush/index.html b/docs/en/gun/1.3/manual/gun.flush/index.html new file mode 100644 index 00000000..8d1dca41 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.flush/index.html @@ -0,0 +1,185 @@ + + + + + + + + + + Nine Nines: gun:flush(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:flush(3)

    + +

    Name

    +

    gun:flush - Flush all messages related to a connection or a stream

    +

    Description

    +
    +
    flush(ConnPid) -> ok
+flush(StreamRef) -> ok
+
+ConnPid    :: pid()
+StreamRef  :: reference()
    +
    +

    Flush all messages related to a connection or a stream.

    +

    Arguments

    +

    Either of these arguments may be provided:

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    +

    Return value

    +

    The atom ok is returned.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Flush all messages from a connection
    +
    +
    gun:flush(ConnPid).
    +
    +
    Flush messages from a single stream
    +
    +
    gun:flush(StreamRef).
    +
    +

    See also

    +

    gun(3), gun:await(3), gun:await_body(3), gun:await_up(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.get/index.html b/docs/en/gun/1.3/manual/gun.get/index.html new file mode 100644 index 00000000..905f5aa3 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.get/index.html @@ -0,0 +1,203 @@ + + + + + + + + + + Nine Nines: gun:get(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:get(3)

    + +

    Name

    +

    gun:get - Get a resource representation

    +

    Description

    +
    +
    get(ConnPid, Path)
+    -> get(ConnPid, Path, [], #{}).
+
+get(ConnPid, Path, Headers)
+    -> get(ConnPid, Path, Headers, #{})
+
+get(ConnPid, Path, Headers, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Get a resource representation.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Get a resource representation
    +
    +
    StreamRef = gun:get(ConnPid, "/articles", [
+    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
+]).
    +
    +
    Get a resource representation with request options
    +
    +
    StreamRef = gun:get(ConnPid, "/articles", [], #{
+    reply_to => ReplyToPid
+}).
    +
    +

    See also

    +

    gun(3), gun:head(3), gun:await(3), gun:await_body(3), gun_push(3), gun_inform(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.head/index.html b/docs/en/gun/1.3/manual/gun.head/index.html new file mode 100644 index 00000000..238d4b2e --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.head/index.html @@ -0,0 +1,205 @@ + + + + + + + + + + Nine Nines: gun:head(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:head(3)

    + +

    Name

    +

    gun:head - Get headers of a resource representation

    +

    Description

    +
    +
    head(ConnPid, Path)
+    -> head(ConnPid, Path, [], #{}).
+
+head(ConnPid, Path, Headers)
+    -> head(ConnPid, Path, Headers, #{})
+
+head(ConnPid, Path, Headers, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Get headers of a resource representation.

    +

    This function performs the same operation as gun:get(3), except the server will not send the resource representation, only the response's status code and headers.

    +

    While servers are supposed to send the same headers as for a GET request, they sometimes will not. For example the content-length header may be dropped from the response.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Get headers of a resource representation
    +
    +
    StreamRef = gun:head(ConnPid, "/articles", [
+    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
+]).
    +
    +
    Get headers of a resource representation with request options
    +
    +
    StreamRef = gun:head(ConnPid, "/articles", [], #{
+    reply_to => ReplyToPid
+}).
    +
    +

    See also

    +

    gun(3), gun:head(3), gun:await(3), gun_push(3), gun_inform(3), gun_response(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.info/index.html b/docs/en/gun/1.3/manual/gun.info/index.html new file mode 100644 index 00000000..c77084a4 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.info/index.html @@ -0,0 +1,191 @@ + + + + + + + + + + Nine Nines: gun:info(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:info(3)

    + +

    Name

    +

    gun:info - Obtain information about the connection

    +

    Description

    +
    +
    info(ConnPid) -> Info
+
+ConnPid :: pid()
+Info :: #{
+    socket         => inet:socket() | ssl:sslsocket(),
+    transport      => tcp | tls,
+    protocol       => http | http2 | ws,
+    sock_ip        => inet:ip_address(),
+    sock_port      => inet:port_number(),
+    origin_host    => inet:hostname() | inet:ip_address(),
+    origin_port    => inet:port_number(),
+    intermediaries => [Intermediary]
+}
+Intermediary :: #{
+    type      => connect,
+    host      => inet:hostname() | inet:ip_address(),
+    port      => inet:port_number(),
+    transport => tcp | tls,
+    protocol  => http | http2
+}
    +
    +

    Obtain information about the connection.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    +

    Return value

    +

    A map is returned containing various informations about the connection.

    +

    Changelog

    +
    • 1.3: The values socket, transport, protocol, origin_host, origin_port and intermediaries were added. +
      • +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Obtain information about the connection
    +
    +
    Info = gun:info(ConnPid).
    +
    +

    See also

    +

    gun(3), gun:open(3), gun:open_unix(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.open/index.html b/docs/en/gun/1.3/manual/gun.open/index.html new file mode 100644 index 00000000..ad625a6e --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.open/index.html @@ -0,0 +1,196 @@ + + + + + + + + + + Nine Nines: gun:open(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:open(3)

    + +

    Name

    +

    gun:open - Open a connection to the given host and port

    +

    Description

    +
    +
    open(Host, Port)       -> open(Host, Port, #{})
+open(Host, Port, Opts) -> {ok, pid()} | {error, any()}
+
+Host :: inet:hostname() | inet:ip_address()
+Port :: inet:port_number()
+Opts :: gun:opts()
    +
    +

    Open a connection to the given host and port.

    +

    Arguments

    +
    Host
    +

    Host or IP address to connect to.

    +
    +
    Port
    +

    Port to connect to.

    +
    +
    Opts
    +

    Options for this connection.

    +
    +
    +

    Return value

    +

    The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the gun_up(3) message will be sent for that.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Connect to a server
    +
    +
    {ok, ConnPid} = gun:open("example.org", 443).
    +
    +
    Connect to a server with custom options
    +
    +
    {ok, ConnPid} = gun:open("example.org", 443,
+    #{protocols => [http2]}).
    +
    +
    Connect to a server using its IP address
    +
    +
    {ok, ConnPid} = gun:open({127,0,0,1}, 443).
    +
    +

    See also

    +

    gun(3), gun:open_unix(3), gun:await_up(3), gun_up(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + 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 new file mode 100644 index 00000000..7257172c --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.open_unix/index.html @@ -0,0 +1,184 @@ + + + + + + + + + + Nine Nines: gun:open_unix(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:open_unix(3)

    + +

    Name

    +

    gun:open_unix - Open a connection to the given Unix domain socket

    +

    Description

    +
    +
    open_unix(SocketPath, Opts) -> {ok, pid()} | {error, any()}
+
+SocketPath :: string()
+Opts       :: gun:opts()
    +
    +

    Open a connection to the given Unix domain socket.

    +

    Arguments

    +
    SocketPath
    +

    Path to the Unix domain socket to connect to.

    +
    +
    Opts
    +

    Options for this connection.

    +
    +
    +

    Return value

    +

    The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the gun_up(3) message will be sent for that.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Connect to a server via a Unix domain socket
    +
    +
    {ok, ConnPid} = gun:open_unix("/var/run/dbus/system_bus_socket", #{}).
    +
    +
    Connect to a server via a Unix domain socket with custom options
    +
    +
    {ok, ConnPid} = gun:open_unix("/var/run/dbus/system_bus_socket",
+    #{protocols => [http2]}).
    +
    +

    See also

    +

    gun(3), gun:open(3), gun:await_up(3), gun_up(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.options/index.html b/docs/en/gun/1.3/manual/gun.options/index.html new file mode 100644 index 00000000..faf271ac --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.options/index.html @@ -0,0 +1,200 @@ + + + + + + + + + + Nine Nines: gun:options(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:options(3)

    + +

    Name

    +

    gun:options - Query the capabilities of the server or a resource

    +

    Description

    +
    +
    options(ConnPid, Path)
+    -> options(ConnPid, Path, [], #{}).
+
+options(ConnPid, Path, Headers)
+    -> options(ConnPid, Path, Headers, #{})
+
+options(ConnPid, Path, Headers, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Query the capabilities of the server or a resource.

    +

    The special path "*" can be used to obtain information about the server as a whole. Any other path will return information about that resource specifically.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Query the capabilities of the server
    +
    +
    StreamRef = gun:options(ConnPid, "*").
    +
    +
    Query the capabilities of a resource
    +
    +
    StreamRef = gun:options(ConnPid, "/articles").
    +
    +

    See also

    +

    gun(3), gun:await(3), gun:await_body(3), gun_inform(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.patch/index.html b/docs/en/gun/1.3/manual/gun.patch/index.html new file mode 100644 index 00000000..996ac874 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.patch/index.html @@ -0,0 +1,223 @@ + + + + + + + + + + Nine Nines: gun:patch(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:patch(3)

    + +

    Name

    +

    gun:patch - Apply a set of changes to a resource

    +

    Description

    +
    +
    patch(ConnPid, Path, Headers)
+    -> StreamRef
+
+patch(ConnPid, Path, Headers, Body)
+    -> patch(ConnPid, Path, Headers, Body, #{})
+
+patch(ConnPid, Path, Headers, Body, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+Body      :: iodata()
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Apply a set of changes to a resource.

    +

    The behavior of this function varies depending on whether a body is provided.

    +

    The function patch/3 expects either a content-length or content-type header to indicate that a body will be sent afterwards. The body can then be sent using gun:data(3).

    +

    The function patch/4,5 sends the entire request, including the request body, immediately. It is therefore not possible to use gun:data(3) after that. You should provide a content-type header. Gun will set the content-length header automatically.

    +

    The body sent in this request should be a patch document with instructions on how to update the resource.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    Body
    +

    Request body.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Patch a resource
    +
    +
    StreamRef = gun:patch(ConnPid, "/users/1",
+    [{<<"content-type">>, <<"application/json-patch+json">>}],
+    <<"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]">>).
    +
    +
    Patch a resource in multiple calls
    +
    +
    StreamRef = gun:patch(ConnPid, "/users/1", [
+    {<<"content-type">>, <<"application/json-patch+json">>}
+]).
+gun:data(ConnPid, StreamRef, fin,
+    <<"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]">>).
    +
    +
    Patch a resource with request options
    +
    +
    StreamRef = gun:patch(ConnPid, "/users/1",
+    [{<<"content-type">>, <<"application/json-patch+json">>}],
+    <<"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]">>,
+    #{reply_to => ReplyToPid}).
    +
    +

    See also

    +

    gun(3), gun:post(3), gun:put(3), gun:await(3), gun:await_body(3), gun_push(3), gun_inform(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.post/index.html b/docs/en/gun/1.3/manual/gun.post/index.html new file mode 100644 index 00000000..cd339ca8 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.post/index.html @@ -0,0 +1,221 @@ + + + + + + + + + + Nine Nines: gun:post(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:post(3)

    + +

    Name

    +

    gun:post - Process the enclosed representation according to a resource's own semantics

    +

    Description

    +
    +
    post(ConnPid, Path, Headers)
+    -> StreamRef
+
+post(ConnPid, Path, Headers, Body)
+    -> post(ConnPid, Path, Headers, Body, #{})
+
+post(ConnPid, Path, Headers, Body, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+Body      :: iodata()
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Process the enclosed representation according to a resource's own semantics.

    +

    The behavior of this function varies depending on whether a body is provided.

    +

    The function post/3 expects either a content-length or content-type header to indicate that a body will be sent afterwards. The body can then be sent using gun:data(3).

    +

    The function post/4,5 sends the entire request, including the request body, immediately. It is therefore not possible to use gun:data(3) after that. You should provide a content-type header. Gun will set the content-length header automatically.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    Body
    +

    Request body.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Post to a resource
    +
    +
    StreamRef = gun:post(ConnPid, "/search",
+    [{<<"content-type">>, <<"application/x-www-form-urlencoded">>}],
+    <<"q=nine%20nines">>).
    +
    +
    Post to a resource in multiple calls
    +
    +
    StreamRef = gun:post(ConnPid, "/search", [
+    {<<"content-type">>, <<"application/x-www-form-urlencoded">>}
+]).
+gun:data(ConnPid, StreamRef, fin, <<"q=nine%20nines">>).
    +
    +
    Post to a resource with request options
    +
    +
    StreamRef = gun:post(ConnPid, "/search",
+    [{<<"content-type">>, <<"application/x-www-form-urlencoded">>}],
+    <<"q=nine%20nines">>,
+    #{reply_to => ReplyToPid}).
    +
    +

    See also

    +

    gun(3), gun:patch(3), gun:put(3), gun:await(3), gun:await_body(3), gun_push(3), gun_inform(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.put/index.html b/docs/en/gun/1.3/manual/gun.put/index.html new file mode 100644 index 00000000..a9661ec7 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.put/index.html @@ -0,0 +1,221 @@ + + + + + + + + + + Nine Nines: gun:put(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:put(3)

    + +

    Name

    +

    gun:put - Create or replace a resource

    +

    Description

    +
    +
    put(ConnPid, Path, Headers)
+    -> StreamRef
+
+put(ConnPid, Path, Headers, Body)
+    -> put(ConnPid, Path, Headers, Body, #{})
+
+put(ConnPid, Path, Headers, Body, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+Body      :: iodata()
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Create or replace a resource.

    +

    The behavior of this function varies depending on whether a body is provided.

    +

    The function put/3 expects either a content-length or content-type header to indicate that a body will be sent afterwards. The body can then be sent using gun:data(3).

    +

    The function put/4,5 sends the entire request, including the request body, immediately. It is therefore not possible to use gun:data(3) after that. You should provide a content-type header. Gun will set the content-length header automatically.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    Body
    +

    Request body.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Put a resource
    +
    +
    StreamRef = gun:put(ConnPid, "/lang/fr_FR/hello",
+    [{<<"content-type">>, <<"text/plain">>}],
+    <<"Bonjour !">>).
    +
    +
    Put a resource in multiple calls
    +
    +
    StreamRef = gun:put(ConnPid, "/lang/fr_FR/hello", [
+    {<<"content-type">>, <<"text/plain">>}
+]).
+gun:data(ConnPid, StreamRef, fin, <<"Bonjour !">>).
    +
    +
    Put a resource with request options
    +
    +
    StreamRef = gun:put(ConnPid, "/lang/fr_FR/hello",
+    [{<<"content-type">>, <<"text/plain">>}],
+    <<"Bonjour !">>,
+    #{reply_to => ReplyToPid}).
    +
    +

    See also

    +

    gun(3), gun:patch(3), gun:post(3), gun:await(3), gun:await_body(3), gun_push(3), gun_inform(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun.request/index.html b/docs/en/gun/1.3/manual/gun.request/index.html new file mode 100644 index 00000000..f32221c5 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.request/index.html @@ -0,0 +1,207 @@ + + + + + + + + + + Nine Nines: gun:request(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:request(3)

    + +

    Name

    +

    gun:request - Perform the given request

    +

    Description

    +
    +
    request(ConnPid, Method, Path, Headers)
+    -> StreamRef
+
+request(ConnPid, Method, Path, Headers, Body)
+    -> request(ConnPid, Method, Path, Headers, Body, #{})
+
+request(ConnPid, Method, Path, Headers, Body, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Method    :: binary()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+Body      :: iodata()
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
    +
    +

    Perform the given request.

    +

    This is a general purpose function that should only be used when other method-specific functions do not apply.

    +

    The behavior of this function varies depending on whether a body is provided.

    +

    The function request/4 expects either a content-length or content-type header to indicate that a body will be sent afterwards. Gun will assume the request has no body otherwise. The body can then be sent using gun:data(3).

    +

    The function request/5,6 sends the entire request, including the request body, immediately. It is therefore not possible to use gun:data(3) after that. You should provide a content-type header. Gun will set the content-length header automatically.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Method
    +

    Method to be used for the request.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    Body
    +

    Request body.

    +
    +
    ReqOpts
    +

    Request options.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Perform a request
    +
    +
    StreamRef = gun:request(ConnPid, <<"PUT">>,
+    "/lang/fr_FR/hello",
+    [{<<"content-type">>, <<"text/plain">>}],
+    <<"Bonjour !">>).
    +
    +

    See also

    +

    gun(3), gun:await(3), gun:await_body(3), gun_push(3), gun_inform(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + 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 new file mode 100644 index 00000000..eb64e7c5 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.ws_send/index.html @@ -0,0 +1,189 @@ + + + + + + + + + + Nine Nines: gun:ws_send(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:ws_send(3)

    + +

    Name

    +

    gun:ws_send - Send Websocket frames

    +

    Description

    +
    +
    ws_send(ConnPid, Frames) -> ok
+
+ConnPid :: pid()
+Frames  :: Frame | [Frame]
+Frame   :: close | ping | pong
+         | {text | binary | close | ping | pong, iodata()}
+         | {close, non_neg_integer(), iodata()}
    +
    +

    Send Websocket frames.

    +

    The connection must first be upgraded to Websocket using the function gun:ws_upgrade(3).

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Frames
    +

    A Websocket frame.

    +
    +
    + +

    Return value

    +

    The atom ok is returned.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Send a single frame
    +
    +
    gun:ws_send(ConnPid, {text, <<"Hello world!">>}).
    +
    + + + + + + + + +

    See also

    +

    gun(3), gun:ws_upgrade(3), gun_upgrade(3), gun_ws(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + 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 new file mode 100644 index 00000000..bf5219e9 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.ws_upgrade/index.html @@ -0,0 +1,213 @@ + + + + + + + + + + Nine Nines: gun:ws_upgrade(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun:ws_upgrade(3)

    + +

    Name

    +

    gun:ws_upgrade - Upgrade to Websocket

    +

    Description

    +
    +
    ws_upgrade(ConnPid, Path)
+    -> ws_upgrade(ConnPid, Path, [])
+
+ws_upgrade(ConnPid, Path, Headers)
+    -> StreamRef
+
+ws_upgrade(ConnPid, Path, Headers, WsOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+WsOpts    :: gun:ws_opts
+StreamRef :: reference()
    +
    +

    Upgrade to Websocket.

    +

    The behavior of this function depends on the protocol selected.

    +

    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.

    +

    Gun does not currently support Websocket over HTTP/2.

    +

    By default Gun will take the Websocket options from the connection's ws_opts.

    +

    Arguments

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Path
    +

    Path to the resource.

    +
    +
    Headers
    +

    Additional request headers.

    +
    +
    WsOpts
    +

    Configuration for the Websocket protocol.

    +
    +
    +

    Return value

    +

    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.

    +

    Changelog

    +
    • 1.0: Function introduced. +
      • +
    +

    Examples

    +
    Upgrade to Websocket
    +
    +
    StreamRef = gun:ws_upgrade(ConnPid, "/ws", [
+    {<<"sec-websocket-protocol">>, <<"chat">>}
+]).
+receive
+    {gun_upgrade, ConnPid, StreamRef, [<<"websocket">>], _} ->
+        ok
+after 5000 ->
+    error(timeout)
+end.
    +
    +
    Upgrade to Websocket with different options
    +
    +
    StreamRef = gun:ws_upgrade(ConnPid, "/ws", [], #{
+    compress => false
+}).
    +
    +

    See also

    +

    gun(3), gun:ws_send(3), gun_upgrade(3), gun_ws(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun/index.html b/docs/en/gun/1.3/manual/gun/index.html new file mode 100644 index 00000000..5adb9ade --- /dev/null +++ b/docs/en/gun/1.3/manual/gun/index.html @@ -0,0 +1,405 @@ + + + + + + + + + + Nine Nines: gun(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun(3)

    + +

    Name

    +

    gun - Asynchronous HTTP client

    +

    Description

    +

    The gun module provides an asynchronous interface for connecting and communicating with Web servers over HTTP, HTTP/2 or Websocket.

    +

    Exports

    +

    Connection:

    + + + +

    Requests:

    + +

    Proxies:

    + +

    Messages:

    + +

    Streams:

    + +

    Websocket:

    + +

    Messages

    +

    Gun will inform the calling process of events asynchronously by sending any of the following messages:

    +

    Connection:

    + +

    Responses:

    + +

    Websocket:

    + +

    The response messages will be sent to the process that opened the connection by default. The reply_to request option can be used to redirect request-specific messages to a different process.

    +

    Types

    +

    connect_destination()

    +
    +
    connect_destination() :: #{
+    host      := inet:hostname() | inet:ip_address(),
+    port      := inet:port_number(),
+
+    username  => iodata(),
+    password  => iodata(),
+    protocols => [http | http2],
+    transport => tcp | tls,
+
+    tls_opts              => [ssl:connect_option()],
+    tls_handshake_timeout => timeout()
+}
    +
    +

    Destination of a CONNECT request.

    +

    The default value, if any, is given next to the option name:

    +
    host, port
    +

    Destination hostname and port number. Mandatory.

    +

    Upon successful completion of the CONNECT request, Gun will begin using these as the host and port of the origin server for subsequent requests.

    +
    +
    username, password
    +

    Proxy authorization credentials. They are only sent when both options are provided.

    +
    +
    protocol (http)
    +

    Protocol that will be used for tunneled requests.

    +
    +
    transport (tcp)
    +

    Transport that will be used for tunneled requests. Note that due to Erlang/OTP limitations it is not possible to tunnel a TLS connection inside a TLS tunnel.

    +
    +
    tls_opts ([])
    +

    Options to use for tunneled TLS connections.

    +
    +
    tls_handshake_timeout (infinity)
    +

    Handshake timeout for tunneled TLS connections.

    +
    +
    +

    http_opts()

    +
    +
    http_opts() :: #{
+    keepalive             => timeout(),
+    transform_header_name => fun((binary()) -> binary()),
+    version               => 'HTTP/1.1' | 'HTTP/1.0'
+}
    +
    +

    Configuration for the HTTP protocol.

    +

    The default value is given next to the option name:

    + +
    keepalive (5000)
    +

    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. Use infinity to disable.

    +
    +
    transform_header_name - see below
    +

    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.

    +
    +
    version ('HTTP/1.1')
    +

    HTTP version to use.

    +
    +
    +

    http2_opts()

    +
    +
    http2_opts() :: #{
+    keepalive => timeout()
+}
    +
    +

    Configuration for the HTTP/2 protocol.

    +

    The default value is given next to the option name:

    + +
    keepalive (5000)
    +

    Time between pings in milliseconds.

    +
    +
    + +

    opts()

    +
    +
    opts() :: #{
+    connect_timeout => timeout(),
+    http_opts       => http_opts(),
+    http2_opts      => http2_opts(),
+    protocols       => [http | http2],
+    retry           => non_neg_integer(),
+    retry_timeout   => pos_integer(),
+    trace           => boolean(),
+    transport       => tcp | tls,
+    transport_opts  => [gen_tcp:connect_option()] | [ssl:connect_option()],
+    ws_opts         => ws_opts()
+}
    +
    +

    Configuration for the connection.

    +

    The default value is given next to the option name:

    +
    connect_timeout (infinity)
    +

    Connection timeout.

    +
    +
    http_opts (#{})
    +

    Options specific to the HTTP protocol.

    +
    +
    http2_opts (#{})
    +

    Options specific to the HTTP/2 protocol.

    +
    +
    protocols - see below
    +

    Ordered list of preferred protocols. When the transport is tcp, this list must contain exactly one protocol. When the transport is tls, 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 http will always be used. Defaults to [http] when the transport is tcp, and [http2, http] when the transport is tls.

    +
    +
    retry (5)
    +

    Number of times Gun will try to reconnect on failure before giving up.

    +
    +
    retry_timeout (5000)
    +

    Time between retries in milliseconds.

    +
    +
    trace (false)
    +

    Whether to enable dbg tracing of the connection process. Should only be used during debugging.

    +
    +
    transport - see below
    +

    Whether to use TLS or plain TCP. The default varies depending on the port used. Port 443 defaults to tls. All other ports default to tcp.

    +
    +
    transport_opts ([])
    +

    Transport options. They are TCP options or TLS options depending on the selected transport.

    +
    +
    ws_opts (#{})
    +

    Options specific to the Websocket protocol.

    +
    +
    +

    req_opts()

    +
    +
    req_opts() :: #{
+    reply_to => pid()
+}
    +
    +

    Configuration for a particular request.

    +

    The default value is given next to the option name:

    +
    reply_to (self())
    +

    The pid of the process that will receive the response messages.

    +
    +
    +

    ws_opts()

    +
    +
    ws_opts() :: #{
+    compress  => boolean(),
+    protocols => [{binary(), module()}]
+}
    +
    +

    Configuration for the Websocket protocol.

    +

    The default value is given next to the option name:

    +
    compress (false)
    +

    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.

    +
    +
    protocols ([])
    +

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

    +
    +
    + +

    Changelog

    +
    • 1.3: Add the CONNECT destination's protocols option and deprecate the previously introduced protocol option. +
      • +
    • 1.2: Introduce the type connect_destination(). +
      • +
    +

    See also

    +

    gun(7)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_app/index.html b/docs/en/gun/1.3/manual/gun_app/index.html new file mode 100644 index 00000000..a8ff4265 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_app/index.html @@ -0,0 +1,165 @@ + + + + + + + + + + Nine Nines: gun(7) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun(7)

    + +

    Name

    +

    gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP

    +

    Description

    +

    Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.

    +

    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.

    +

    Modules

    +
    • gun(3) - Asynchronous HTTP client +
      • +
    +

    Dependencies

    +
    • cowlib(7) - Support library for manipulating Web protocols +
      • +
    • ssl - Secure communication over sockets +
      • +
    +

    All these applications must be started before the gun application. To start Gun and all dependencies at once:

    +
    +
    {ok, _} = application:ensure_all_started(gun).
    +
    +

    Environment

    +

    The gun application does not define any application environment configuration parameters.

    +

    See also

    +

    cowlib(7)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_data/index.html b/docs/en/gun/1.3/manual/gun_data/index.html new file mode 100644 index 00000000..59533503 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_data/index.html @@ -0,0 +1,189 @@ + + + + + + + + + + Nine Nines: gun_data(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_data(3)

    + +

    Name

    +

    gun_data - Response body

    +

    Description

    +
    +
    {gun_data, ConnPid, StreamRef, IsFin, Data}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+IsFin     :: fin | nofin
+Data      :: binary()
    +
    +

    Response body.

    +

    This message informs the relevant process that the server sent a all or part of the body for the response to the original request.

    +

    A data message is always preceded by a response message.

    +

    The response body may be terminated either by a data message with the flag fin set or by a gun_trailers(3) message.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    IsFin
    +

    Whether this message terminates the response.

    +
    +
    Data
    +

    All or part of the response body.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_data message in a gen_server
    +
    +
    handle_info({gun_data, ConnPid, _StreamRef,
+             _IsFin, _Data},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:head(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:options(3), gun:request(3), gun_response(3), gun_trailers(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_down/index.html b/docs/en/gun/1.3/manual/gun_down/index.html new file mode 100644 index 00000000..44f10ac3 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_down/index.html @@ -0,0 +1,195 @@ + + + + + + + + + + Nine Nines: gun_down(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_down(3)

    + +

    Name

    +

    gun_down - The connection is down

    +

    Description

    +
    +
    {gun_down, ConnPid, Protocol, Reason, KilledStreams, UnprocessedStreams}
+
+ConnPid            :: pid()
+Protocol           :: http | http2 | ws
+Reason             :: any()
+KilledStreams      :: [reference()]
+UnprocessedStreams :: [reference()]
    +
    +

    The connection is down.

    +

    This message informs the owner process that the connection was lost. Depending on the retry and retry_timeout options Gun may automatically attempt to reconnect.

    +

    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.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Protocol
    +

    The protocol that was selected for this connection or upgraded to during the course of the connection.

    +
    +
    Reason
    +

    The reason for the loss of the connection.

    +

    It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.

    +
    +
    KilledStreams
    +

    List of streams that have been brutally terminated.

    +

    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.

    +
    +
    UnprocessedStreams
    +

    List of streams that have not been processed by the server.

    +

    They are streams that the server did not start processing yet. They may be retried safely depending on whether related streams were killed.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_down message in a gen_server
    +
    +
    handle_info({gun_down, ConnPid, _Protocol,
+             _Reason, _Killed, _Unprocessed},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:open(3), gun:open_unix(3), gun_up(3), gun_error(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_error/index.html b/docs/en/gun/1.3/manual/gun_error/index.html new file mode 100644 index 00000000..fe4744ab --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_error/index.html @@ -0,0 +1,188 @@ + + + + + + + + + + Nine Nines: gun_error(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_error(3)

    + +

    Name

    +

    gun_error - Stream or connection-wide error

    +

    Description

    +
    +
    {gun_error, ConnPid, StreamRef, Reason}
+{gun_error, ConnPid, Reason}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Reason    :: any()
    +
    +

    Stream or connection-wide error.

    +

    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.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream that resulted in an error.

    +
    +
    Reason
    +

    The reason for the error.

    +

    It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_error message in a gen_server
    +
    +
    handle_info({gun_error, ConnPid, _Reason},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State};
+handle_info({gun_error, ConnPid, _StreamRef, _Reason},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun_up(3), gun_down(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_inform/index.html b/docs/en/gun/1.3/manual/gun_inform/index.html new file mode 100644 index 00000000..b2b03cf1 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_inform/index.html @@ -0,0 +1,188 @@ + + + + + + + + + + Nine Nines: gun_inform(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_inform(3)

    + +

    Name

    +

    gun_inform - Informational response

    +

    Description

    +
    +
    {gun_inform, ConnPid, StreamRef, Status, Headers}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Status    :: 100..199
+Headers   :: [{binary(), binary()}]
    +
    +

    Informational response.

    +

    This message informs the relevant process that the server sent an informational response to the original request.

    +

    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.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    Status
    +

    Status code for the informational response.

    +
    +
    Headers
    +

    Headers sent with the informational response.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_inform message in a gen_server
    +
    +
    handle_info({gun_inform, ConnPid, _StreamRef,
+             _Status, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:patch(3), gun:post(3), gun:put(3), gun_response(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_push/index.html b/docs/en/gun/1.3/manual/gun_push/index.html new file mode 100644 index 00000000..9f4c28cc --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_push/index.html @@ -0,0 +1,208 @@ + + + + + + + + + + Nine Nines: gun_push(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_push(3)

    + +

    Name

    +

    gun_push - Server-initiated push

    +

    Description

    +
    +
    {gun_push, ConnPid, StreamRef, NewStreamRef, Method, URI, Headers}
+
+ConnPid      :: pid()
+StreamRef    :: reference()
+NewStreamRef :: reference()
+Method       :: binary()
+URI          :: binary()
+Headers      :: [{binary(), binary()}]
    +
    +

    Server-initiated push.

    +

    This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request.

    +

    A server-initiated push message always precedes the response to the original request.

    +

    This message will not be sent when using the HTTP/1.1 protocol because it lacks the concept of server-initiated push.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    NewStreamRef
    +

    Identifier of the stream being pushed.

    +
    +
    Method
    +

    Method of the equivalent HTTP request.

    +
    +
    URI
    +

    URI of the resource being pushed.

    +
    +
    Headers
    +

    Headers of the equivalent HTTP request.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_push message in a gen_server
    +
    +
    handle_info({gun_push, ConnPid, _StreamRef,
+             _NewStreamRef, _Method, _URI, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +
    Cancel an unwanted push
    +
    +
    handle_info({gun_push, ConnPid, _StreamRef,
+             NewStreamRef, _Method, _URI, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    gun:cancel(ConnPid, NewStreamRef),
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:cancel(3), gun_response(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_response/index.html b/docs/en/gun/1.3/manual/gun_response/index.html new file mode 100644 index 00000000..b4135f1c --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_response/index.html @@ -0,0 +1,191 @@ + + + + + + + + + + Nine Nines: gun_response(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_response(3)

    + +

    Name

    +

    gun_response - Response

    +

    Description

    +
    +
    {gun_response, ConnPid, StreamRef, IsFin, Status, Headers}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+IsFin     :: fin | nofin
+Status    :: non_neg_integer()
+Headers   :: [{binary(), binary()}]
    +
    +

    Response.

    +

    This message informs the relevant process that the server sent a response to the original request.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    IsFin
    +

    Whether this message terminates the response.

    +
    +
    Status
    +

    Status code for the response.

    +
    +
    Headers
    +

    Headers sent with the response.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_response message in a gen_server
    +
    +
    handle_info({gun_response, ConnPid, _StreamRef,
+             _IsFin, _Status, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:head(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:options(3), gun:request(3), gun_inform(3), gun_push(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_trailers/index.html b/docs/en/gun/1.3/manual/gun_trailers/index.html new file mode 100644 index 00000000..712694bf --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_trailers/index.html @@ -0,0 +1,183 @@ + + + + + + + + + + Nine Nines: gun_trailers(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_trailers(3)

    + +

    Name

    +

    gun_trailers - Response trailers

    +

    Description

    +
    +
    {gun_trailers, ConnPid, StreamRef, Headers}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Headers   :: [{binary(), binary()}]
    +
    +

    Response trailers.

    +

    This message informs the relevant process that the server sent response trailers for the response to the original request.

    +

    A trailers message terminates the response.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream for the original request.

    +
    +
    Headers
    +

    Trailing headers sent after the response body.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_trailers message in a gen_server
    +
    +
    handle_info({gun_trailers, ConnPid, _StreamRef, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:get(3), gun:head(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:options(3), gun:request(3), gun_response(3), gun_data(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_up/index.html b/docs/en/gun/1.3/manual/gun_up/index.html new file mode 100644 index 00000000..1cab2e56 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_up/index.html @@ -0,0 +1,179 @@ + + + + + + + + + + Nine Nines: gun_up(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_up(3)

    + +

    Name

    +

    gun_up - The connection is up

    +

    Description

    +
    +
    {gun_up, ConnPid, Protocol}
+
+ConnPid  :: pid()
+Protocol :: http | http2
    +
    +

    The connection is up.

    +

    This message informs the owner process that the connection or reconnection completed.

    +

    Gun will now 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.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    Protocol
    +

    The protocol selected for this connection. It can be used to determine the capabilities of the server.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_up message in a gen_server
    +
    +
    handle_info({gun_up, ConnPid, _Protocol},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:open(3), gun:open_unix(3), gun:await_up(3), gun_down(3), gun_error(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_upgrade/index.html b/docs/en/gun/1.3/manual/gun_upgrade/index.html new file mode 100644 index 00000000..a62cc7fb --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_upgrade/index.html @@ -0,0 +1,189 @@ + + + + + + + + + + Nine Nines: gun_upgrade(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_upgrade(3)

    + +

    Name

    +

    gun_upgrade - Successful protocol upgrade

    +

    Description

    +
    +
    {gun_upgrade, ConnPid, StreamRef, Protocols, Headers}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Protocols :: [<<"websocket">>]
+Headers   :: [{binary(), binary()}]
    +
    +

    Successful protocol upgrade.

    +

    This message informs the relevant process that the server accepted to upgrade to one or more protocols given in the original request.

    +

    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.

    +

    Gun currently only supports upgrading HTTP/1.1 connections to the Websocket protocol.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream that resulted in an upgrade.

    +
    +
    Protocols
    +

    List of protocols this stream was upgraded to.

    +
    +
    Headers
    +

    Headers sent with the upgrade response.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_upgrade message in a gen_server
    +
    +
    handle_info({gun_upgrade, ConnPid, _StreamRef,
+             _Protocols, _Headers},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:ws_upgrade(3), gun:ws_send(3), gun_ws(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/gun_ws/index.html b/docs/en/gun/1.3/manual/gun_ws/index.html new file mode 100644 index 00000000..f4de50c1 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun_ws/index.html @@ -0,0 +1,185 @@ + + + + + + + + + + Nine Nines: gun_ws(3) + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    gun_ws(3)

    + +

    Name

    +

    gun_ws - Websocket frame

    +

    Description

    +
    +
    {gun_ws, ConnPid, StreamRef, Frame}
+
+ConnPid   :: pid()
+StreamRef :: reference()
+Frame     :: close
+           | {text | binary | close, binary()}
+           | {close, non_neg_integer(), binary()}
    +
    +

    Websocket frame.

    +

    This message informs the relevant process that the server sent the enclosed frame.

    +

    This message can only be sent on streams that were upgraded to the Websocket protocol.

    +

    Elements

    +
    ConnPid
    +

    The pid of the Gun connection process.

    +
    +
    StreamRef
    +

    Identifier of the stream that was upgraded to Websocket.

    +
    +
    Frame
    +

    The Websocket frame in question.

    +
    +
    +

    Changelog

    +
    • 1.0: Message introduced. +
      • +
    +

    Examples

    +
    Receive a gun_ws message in a gen_server
    +
    +
    handle_info({gun_ws, ConnPid, _StreamRef, _Frame},
+            State=#state{conn_pid=ConnPid}) ->
+    %% Do something.
+    {noreply, State}.
    +
    +

    See also

    +

    gun(3), gun:ws_upgrade(3), gun:ws_send(3), gun_upgrade(3)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/en/gun/1.3/manual/index.html b/docs/en/gun/1.3/manual/index.html new file mode 100644 index 00000000..87add8bd --- /dev/null +++ b/docs/en/gun/1.3/manual/index.html @@ -0,0 +1,165 @@ + + + + + + + + + + Nine Nines: Gun Function Reference + + + + + + + + + + + + + + +
    +
    +
    +
    +

    99s

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

    Gun Function Reference

    + +

    Name

    +

    gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP

    +

    Description

    +

    Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.

    +

    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.

    +

    Modules

    +
    • gun(3) - Asynchronous HTTP client +
      • +
    +

    Dependencies

    +
    • cowlib(7) - Support library for manipulating Web protocols +
      • +
    • ssl - Secure communication over sockets +
      • +
    +

    All these applications must be started before the gun application. To start Gun and all dependencies at once:

    +
    +
    {ok, _} = application:ensure_all_started(gun).
    +
    +

    Environment

    +

    The gun application does not define any application environment configuration parameters.

    +

    See also

    +

    cowlib(7)

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

    + Gun + 1.3 + Function Reference + +

    + + + +

    Navigation

    + +

    Version select

    + + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/index.html b/docs/index.html index 9c9fdc6a..e9a92a41 100644 --- a/docs/index.html +++ b/docs/index.html @@ -131,6 +131,13 @@