aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2020-11-12 11:25:33 +0100
committerLoïc Hoguin <[email protected]>2020-11-12 11:25:33 +0100
commit01eb4636f7a25ccdd3099629cb0d580ee8688dcc (patch)
tree58bfdaebe56bc2aef594858c271768f25a1cfb14 /doc
parent24f217ee8a45fbc89d4a7615dd0bd360fc839708 (diff)
downloadgun-01eb4636f7a25ccdd3099629cb0d580ee8688dcc.tar.gz
gun-01eb4636f7a25ccdd3099629cb0d580ee8688dcc.tar.bz2
gun-01eb4636f7a25ccdd3099629cb0d580ee8688dcc.zip
Use gun:stream_ref() where applicable
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/gun.await.asciidoc2
-rw-r--r--doc/src/manual/gun.await_body.asciidoc2
-rw-r--r--doc/src/manual/gun.cancel.asciidoc2
-rw-r--r--doc/src/manual/gun.connect.asciidoc2
-rw-r--r--doc/src/manual/gun.data.asciidoc2
-rw-r--r--doc/src/manual/gun.delete.asciidoc2
-rw-r--r--doc/src/manual/gun.flush.asciidoc2
-rw-r--r--doc/src/manual/gun.get.asciidoc2
-rw-r--r--doc/src/manual/gun.head.asciidoc2
-rw-r--r--doc/src/manual/gun.headers.asciidoc2
-rw-r--r--doc/src/manual/gun.options.asciidoc2
-rw-r--r--doc/src/manual/gun.patch.asciidoc2
-rw-r--r--doc/src/manual/gun.post.asciidoc2
-rw-r--r--doc/src/manual/gun.put.asciidoc2
-rw-r--r--doc/src/manual/gun.request.asciidoc2
-rw-r--r--doc/src/manual/gun.stream_info.asciidoc4
-rw-r--r--doc/src/manual/gun.update_flow.asciidoc2
-rw-r--r--doc/src/manual/gun.ws_upgrade.asciidoc2
-rw-r--r--doc/src/manual/gun_data.asciidoc2
-rw-r--r--doc/src/manual/gun_down.asciidoc2
-rw-r--r--doc/src/manual/gun_error.asciidoc2
-rw-r--r--doc/src/manual/gun_inform.asciidoc2
-rw-r--r--doc/src/manual/gun_push.asciidoc4
-rw-r--r--doc/src/manual/gun_response.asciidoc2
-rw-r--r--doc/src/manual/gun_trailers.asciidoc2
-rw-r--r--doc/src/manual/gun_upgrade.asciidoc2
-rw-r--r--doc/src/manual/gun_ws.asciidoc2
27 files changed, 29 insertions, 29 deletions
diff --git a/doc/src/manual/gun.await.asciidoc b/doc/src/manual/gun.await.asciidoc
index 0af6cee..703ce36 100644
--- a/doc/src/manual/gun.await.asciidoc
+++ b/doc/src/manual/gun.await.asciidoc
@@ -21,7 +21,7 @@ await(ConnPid, StreamRef, Timeout, MonitorRef)
-> Result
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
MonitorRef :: reference()
Timeout :: timeout()
Result :: tuple() - see below
diff --git a/doc/src/manual/gun.await_body.asciidoc b/doc/src/manual/gun.await_body.asciidoc
index c2c7133..11f87bc 100644
--- a/doc/src/manual/gun.await_body.asciidoc
+++ b/doc/src/manual/gun.await_body.asciidoc
@@ -21,7 +21,7 @@ await_body(ConnPid, StreamRef, Timeout, MonitorRef)
-> {ok, Body} | {ok, Body, Trailers} | {error, Reason}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
MonitorRef :: reference()
Timeout :: timeout()
Body :: binary()
diff --git a/doc/src/manual/gun.cancel.asciidoc b/doc/src/manual/gun.cancel.asciidoc
index 7072c47..9c2e428 100644
--- a/doc/src/manual/gun.cancel.asciidoc
+++ b/doc/src/manual/gun.cancel.asciidoc
@@ -11,7 +11,7 @@ gun:cancel - Cancel the given stream
cancel(ConnPid, StreamRef) -> ok
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Cancel the given stream.
diff --git a/doc/src/manual/gun.connect.asciidoc b/doc/src/manual/gun.connect.asciidoc
index de40e34..b2bdfe9 100644
--- a/doc/src/manual/gun.connect.asciidoc
+++ b/doc/src/manual/gun.connect.asciidoc
@@ -21,7 +21,7 @@ ConnPid :: pid()
Destination :: gun:connect_destination()
Headers :: gun:req_headers()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Establish a tunnel to the origin server.
diff --git a/doc/src/manual/gun.data.asciidoc b/doc/src/manual/gun.data.asciidoc
index 08387b7..44bae36 100644
--- a/doc/src/manual/gun.data.asciidoc
+++ b/doc/src/manual/gun.data.asciidoc
@@ -11,7 +11,7 @@ gun:data - Stream the body of a request
data(ConnPid, StreamRef, IsFin, Data) -> ok
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
IsFin :: fin | nofin
Data :: iodata()
----
diff --git a/doc/src/manual/gun.delete.asciidoc b/doc/src/manual/gun.delete.asciidoc
index 7367adb..36682f5 100644
--- a/doc/src/manual/gun.delete.asciidoc
+++ b/doc/src/manual/gun.delete.asciidoc
@@ -21,7 +21,7 @@ ConnPid :: pid()
Path :: iodata()
Headers :: gun:req_headers()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Delete a resource.
diff --git a/doc/src/manual/gun.flush.asciidoc b/doc/src/manual/gun.flush.asciidoc
index b6424a9..d4ee0c6 100644
--- a/doc/src/manual/gun.flush.asciidoc
+++ b/doc/src/manual/gun.flush.asciidoc
@@ -12,7 +12,7 @@ flush(ConnPid) -> ok
flush(StreamRef) -> ok
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Flush all messages related to a connection or a stream.
diff --git a/doc/src/manual/gun.get.asciidoc b/doc/src/manual/gun.get.asciidoc
index 64feeab..6c44636 100644
--- a/doc/src/manual/gun.get.asciidoc
+++ b/doc/src/manual/gun.get.asciidoc
@@ -21,7 +21,7 @@ ConnPid :: pid()
Path :: iodata()
Headers :: gun:req_headers()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Get a resource representation.
diff --git a/doc/src/manual/gun.head.asciidoc b/doc/src/manual/gun.head.asciidoc
index 08ce86b..aab97ce 100644
--- a/doc/src/manual/gun.head.asciidoc
+++ b/doc/src/manual/gun.head.asciidoc
@@ -21,7 +21,7 @@ ConnPid :: pid()
Path :: iodata()
Headers :: gun:req_headers()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Get headers of a resource representation.
diff --git a/doc/src/manual/gun.headers.asciidoc b/doc/src/manual/gun.headers.asciidoc
index 4abcb39..24458aa 100644
--- a/doc/src/manual/gun.headers.asciidoc
+++ b/doc/src/manual/gun.headers.asciidoc
@@ -19,7 +19,7 @@ Method :: binary()
Path :: iodata()
Headers :: gun:req_headers()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Initiate the given request.
diff --git a/doc/src/manual/gun.options.asciidoc b/doc/src/manual/gun.options.asciidoc
index dfbba7b..964c601 100644
--- a/doc/src/manual/gun.options.asciidoc
+++ b/doc/src/manual/gun.options.asciidoc
@@ -21,7 +21,7 @@ ConnPid :: pid()
Path :: iodata()
Headers :: gun:req_headers()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Query the capabilities of the server or a resource.
diff --git a/doc/src/manual/gun.patch.asciidoc b/doc/src/manual/gun.patch.asciidoc
index cdc8f97..ee87b2c 100644
--- a/doc/src/manual/gun.patch.asciidoc
+++ b/doc/src/manual/gun.patch.asciidoc
@@ -25,7 +25,7 @@ Path :: iodata()
Headers :: gun:req_headers()
Body :: iodata()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Apply a set of changes to a resource.
diff --git a/doc/src/manual/gun.post.asciidoc b/doc/src/manual/gun.post.asciidoc
index a545a32..e6d08ba 100644
--- a/doc/src/manual/gun.post.asciidoc
+++ b/doc/src/manual/gun.post.asciidoc
@@ -25,7 +25,7 @@ Path :: iodata()
Headers :: gun:req_headers()
Body :: iodata()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Process the enclosed representation according to a resource's
diff --git a/doc/src/manual/gun.put.asciidoc b/doc/src/manual/gun.put.asciidoc
index 7807d68..63cd7c5 100644
--- a/doc/src/manual/gun.put.asciidoc
+++ b/doc/src/manual/gun.put.asciidoc
@@ -25,7 +25,7 @@ Path :: iodata()
Headers :: gun:req_headers()
Body :: iodata()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Create or replace a resource.
diff --git a/doc/src/manual/gun.request.asciidoc b/doc/src/manual/gun.request.asciidoc
index 0a50499..c004b4c 100644
--- a/doc/src/manual/gun.request.asciidoc
+++ b/doc/src/manual/gun.request.asciidoc
@@ -20,7 +20,7 @@ Path :: iodata()
Headers :: gun:req_headers()
Body :: iodata()
ReqOpts :: gun:req_opts()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Perform the given request.
diff --git a/doc/src/manual/gun.stream_info.asciidoc b/doc/src/manual/gun.stream_info.asciidoc
index 8f38020..34817fa 100644
--- a/doc/src/manual/gun.stream_info.asciidoc
+++ b/doc/src/manual/gun.stream_info.asciidoc
@@ -11,9 +11,9 @@ gun:stream_info - Obtain information about a stream
stream_info(ConnPid, StreamRef) -> {ok, undefined | Info} | {error, not_connected}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
Info :: #{
- ref => reference(),
+ ref => gun:stream_ref(),
reply_to => pid(),
state => running | stopping
}
diff --git a/doc/src/manual/gun.update_flow.asciidoc b/doc/src/manual/gun.update_flow.asciidoc
index c7990f2..60e9d78 100644
--- a/doc/src/manual/gun.update_flow.asciidoc
+++ b/doc/src/manual/gun.update_flow.asciidoc
@@ -11,7 +11,7 @@ gun:update_flow - Update a stream's flow control value
update_flow(ConnPid, StreamRef, Flow) -> ok
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
Flow :: pos_integer()
----
diff --git a/doc/src/manual/gun.ws_upgrade.asciidoc b/doc/src/manual/gun.ws_upgrade.asciidoc
index 241d916..b553f3b 100644
--- a/doc/src/manual/gun.ws_upgrade.asciidoc
+++ b/doc/src/manual/gun.ws_upgrade.asciidoc
@@ -21,7 +21,7 @@ ConnPid :: pid()
Path :: iodata()
Headers :: gun:req_headers()
WsOpts :: gun:ws_opts
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
----
Upgrade to Websocket.
diff --git a/doc/src/manual/gun_data.asciidoc b/doc/src/manual/gun_data.asciidoc
index 06797a2..bcae2f8 100644
--- a/doc/src/manual/gun_data.asciidoc
+++ b/doc/src/manual/gun_data.asciidoc
@@ -11,7 +11,7 @@ gun_data - Response body
{gun_data, ConnPid, StreamRef, IsFin, Data}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
IsFin :: fin | nofin
Data :: binary()
----
diff --git a/doc/src/manual/gun_down.asciidoc b/doc/src/manual/gun_down.asciidoc
index a9fabde..f00f8b1 100644
--- a/doc/src/manual/gun_down.asciidoc
+++ b/doc/src/manual/gun_down.asciidoc
@@ -13,7 +13,7 @@ gun_down - The connection is down
ConnPid :: pid()
Protocol :: http | http2 | socks | ws
Reason :: any()
-KilledStreams :: [reference()]
+KilledStreams :: [gun:stream_ref()]
----
The connection is down.
diff --git a/doc/src/manual/gun_error.asciidoc b/doc/src/manual/gun_error.asciidoc
index 800b49c..90c7c33 100644
--- a/doc/src/manual/gun_error.asciidoc
+++ b/doc/src/manual/gun_error.asciidoc
@@ -12,7 +12,7 @@ gun_error - Stream or connection-wide error
{gun_error, ConnPid, Reason}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
Reason :: any()
----
diff --git a/doc/src/manual/gun_inform.asciidoc b/doc/src/manual/gun_inform.asciidoc
index 0d24beb..33d7971 100644
--- a/doc/src/manual/gun_inform.asciidoc
+++ b/doc/src/manual/gun_inform.asciidoc
@@ -11,7 +11,7 @@ gun_inform - Informational response
{gun_inform, ConnPid, StreamRef, Status, Headers}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
Status :: 100..199
Headers :: [{binary(), binary()}]
----
diff --git a/doc/src/manual/gun_push.asciidoc b/doc/src/manual/gun_push.asciidoc
index e73c3b6..fb0b8b1 100644
--- a/doc/src/manual/gun_push.asciidoc
+++ b/doc/src/manual/gun_push.asciidoc
@@ -11,8 +11,8 @@ gun_push - Server-initiated push
{gun_push, ConnPid, StreamRef, NewStreamRef, Method, URI, Headers}
ConnPid :: pid()
-StreamRef :: reference()
-NewStreamRef :: reference()
+StreamRef :: gun:stream_ref()
+NewStreamRef :: gun:stream_ref()
Method :: binary()
URI :: binary()
Headers :: [{binary(), binary()}]
diff --git a/doc/src/manual/gun_response.asciidoc b/doc/src/manual/gun_response.asciidoc
index b273fc3..94edecc 100644
--- a/doc/src/manual/gun_response.asciidoc
+++ b/doc/src/manual/gun_response.asciidoc
@@ -11,7 +11,7 @@ gun_response - Response
{gun_response, ConnPid, StreamRef, IsFin, Status, Headers}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
IsFin :: fin | nofin
Status :: non_neg_integer()
Headers :: [{binary(), binary()}]
diff --git a/doc/src/manual/gun_trailers.asciidoc b/doc/src/manual/gun_trailers.asciidoc
index 8921419..d195ade 100644
--- a/doc/src/manual/gun_trailers.asciidoc
+++ b/doc/src/manual/gun_trailers.asciidoc
@@ -11,7 +11,7 @@ gun_trailers - Response trailers
{gun_trailers, ConnPid, StreamRef, Headers}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
Headers :: [{binary(), binary()}]
----
diff --git a/doc/src/manual/gun_upgrade.asciidoc b/doc/src/manual/gun_upgrade.asciidoc
index 3fc0340..eaea701 100644
--- a/doc/src/manual/gun_upgrade.asciidoc
+++ b/doc/src/manual/gun_upgrade.asciidoc
@@ -11,7 +11,7 @@ gun_upgrade - Successful protocol upgrade
{gun_upgrade, ConnPid, StreamRef, Protocols, Headers}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
Protocols :: [<<"websocket">>]
Headers :: [{binary(), binary()}]
----
diff --git a/doc/src/manual/gun_ws.asciidoc b/doc/src/manual/gun_ws.asciidoc
index 374b0b3..4e5abde 100644
--- a/doc/src/manual/gun_ws.asciidoc
+++ b/doc/src/manual/gun_ws.asciidoc
@@ -11,7 +11,7 @@ gun_ws - Websocket frame
{gun_ws, ConnPid, StreamRef, Frame}
ConnPid :: pid()
-StreamRef :: reference()
+StreamRef :: gun:stream_ref()
Frame :: close | ping | pong
| {text | binary | close, binary()}
| {close, non_neg_integer(), binary()}