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

{ok, ConnPid} = gun:open_unix("/var/run/dbus/system_bus_socket", #{}).

{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)