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.open_unix/index.html | 226 ++++++++++++++++++++++++ 1 file changed, 226 insertions(+) create mode 100644 docs/en/gun/1.0/manual/gun.open_unix/index.html (limited to 'docs/en/gun/1.0/manual/gun.open_unix/index.html') 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 new file mode 100644 index 00000000..96253f64 --- /dev/null +++ b/docs/en/gun/1.0/manual/gun.open_unix/index.html @@ -0,0 +1,226 @@ + + + + + + + + + + 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.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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