From 2b588340af501825f3ab03f2e76dba0353c98fae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 4 Jun 2018 12:59:26 +0200 Subject: Update documentation for Gun 1.0 --- docs/en/gun/1.0/manual/gun.flush/index.html | 224 ++++++++++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 docs/en/gun/1.0/manual/gun.flush/index.html (limited to 'docs/en/gun/1.0/manual/gun.flush/index.html') diff --git a/docs/en/gun/1.0/manual/gun.flush/index.html b/docs/en/gun/1.0/manual/gun.flush/index.html new file mode 100644 index 00000000..13263727 --- /dev/null +++ b/docs/en/gun/1.0/manual/gun.flush/index.html @@ -0,0 +1,224 @@ + + + + + + + + + + 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.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 1.0
    • + +
+ +
+
+
+
+ + + + + + + + + -- cgit v1.2.3