From 6612610964cabadfcf408e4223a702555a3570cb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Wed, 9 Jan 2019 18:12:51 +0100
Subject: Add function gun:stream_info/2

---
 doc/src/manual/gun.asciidoc             |  1 +
 doc/src/manual/gun.cancel.asciidoc      |  3 +-
 doc/src/manual/gun.stream_info.asciidoc | 63 +++++++++++++++++++++++++++++++++
 3 files changed, 66 insertions(+), 1 deletion(-)
 create mode 100644 doc/src/manual/gun.stream_info.asciidoc

(limited to 'doc')

diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc
index 2726564..95ca2ad 100644
--- a/doc/src/manual/gun.asciidoc
+++ b/doc/src/manual/gun.asciidoc
@@ -47,6 +47,7 @@ Messages:
 Streams:
 
 * link:man:gun:cancel(3)[gun:cancel(3)] - Cancel the given stream
+* link:man:gun:stream_info(3)[gun:stream_info(3)] - Obtain information about a stream
 
 Websocket:
 
diff --git a/doc/src/manual/gun.cancel.asciidoc b/doc/src/manual/gun.cancel.asciidoc
index bc2bab9..fd86eba 100644
--- a/doc/src/manual/gun.cancel.asciidoc
+++ b/doc/src/manual/gun.cancel.asciidoc
@@ -65,4 +65,5 @@ link:man:gun:patch(3)[gun:patch(3)],
 link:man:gun:post(3)[gun:post(3)],
 link:man:gun:put(3)[gun:put(3)],
 link:man:gun:delete(3)[gun:delete(3)],
-link:man:gun:request(3)[gun:request(3)]
+link:man:gun:request(3)[gun:request(3)],
+link:man:gun:stream_info(3)[gun:stream_info(3)]
diff --git a/doc/src/manual/gun.stream_info.asciidoc b/doc/src/manual/gun.stream_info.asciidoc
new file mode 100644
index 0000000..8f38020
--- /dev/null
+++ b/doc/src/manual/gun.stream_info.asciidoc
@@ -0,0 +1,63 @@
+= gun:stream_info(3)
+
+== Name
+
+gun:stream_info - Obtain information about a stream
+
+== Description
+
+[source,erlang]
+----
+stream_info(ConnPid, StreamRef) -> {ok, undefined | Info} | {error, not_connected}
+
+ConnPid :: pid()
+StreamRef :: reference()
+Info :: #{
+    ref => reference(),
+    reply_to => pid(),
+    state => running | stopping
+}
+----
+
+Obtain information about a stream.
+
+== Arguments
+
+ConnPid::
+
+The pid of the Gun connection process.
+
+StreamRef::
+
+Identifier of the stream for the original request.
+
+== Return value
+
+A map is returned containing various informations about
+the stream.
+
+== Changelog
+
+* *2.0*: Function introduced.
+
+== Examples
+
+.Obtain information about a stream
+[source,erlang]
+----
+Info = gun:stream_info(ConnPid, StreamRef).
+----
+
+== See also
+
+link:man:gun(3)[gun(3)],
+link:man:gun:get(3)[gun:get(3)],
+link:man:gun:head(3)[gun:head(3)],
+link:man:gun:options(3)[gun:options(3)],
+link:man:gun:patch(3)[gun:patch(3)],
+link:man:gun:post(3)[gun:post(3)],
+link:man:gun:put(3)[gun:put(3)],
+link:man:gun:delete(3)[gun:delete(3)],
+link:man:gun:headers(3)[gun:headers(3)],
+link:man:gun:request(3)[gun:request(3)],
+link:man:gun:cancel(3)[gun:cancel(3)]
-- 
cgit v1.2.3