From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- docs/en/gun/1.0/manual/gun.open_unix/index.html | 100 ++++++------------------ 1 file changed, 26 insertions(+), 74 deletions(-) (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 index 96253f64..60b9c630 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 @@ -62,100 +62,52 @@

gun:open_unix(3)

-

Name

-
-

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

-
-
-
+

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

Description

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

Open a connection to the given Unix domain socket.

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

+
SocketPath
+

Path to the Unix domain socket to connect to.

-
-Opts -
-
-

-Options for this connection. -

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

-
-
-
+

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

    +
    • 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]}).
-
-
-
+
{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(3), gun:open(3), gun:await_up(3), gun_up(3)

+ -- cgit v1.2.3