From eb808a3f8bbd97d2a2ea0114b43b708a17b44066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 11 Apr 2025 14:34:51 +0200 Subject: Gun 2.2.0 --- docs/en/gun/2.2/manual/gun.open_unix/index.html | 209 ++++++++++++++++++++++++ 1 file changed, 209 insertions(+) create mode 100644 docs/en/gun/2.2/manual/gun.open_unix/index.html (limited to 'docs/en/gun/2.2/manual/gun.open_unix') diff --git a/docs/en/gun/2.2/manual/gun.open_unix/index.html b/docs/en/gun/2.2/manual/gun.open_unix/index.html new file mode 100644 index 00000000..471b0145 --- /dev/null +++ b/docs/en/gun/2.2/manual/gun.open_unix/index.html @@ -0,0 +1,209 @@ + + + + + + + + + + Nine Nines: gun:open_unix(3) + + + + + + + + + + + + + + + +
+
+
+
+ +

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, Reason}
+
+SocketPath :: string()
+Opts       :: gun:opts()
+Reason     :: {options, OptName}
+            | {options, {http | http2 | socks | ws, OptName}}
+            | any()
+OptName    :: atom()
+
+

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_tunnel_up(3), gun_up(3)

+ + + + + + +
+ +
+ + +

+ Gun + 2.2 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3