aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/ranch_transport.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/ranch_transport.asciidoc')
-rw-r--r--doc/src/manual/ranch_transport.asciidoc9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/src/manual/ranch_transport.asciidoc b/doc/src/manual/ranch_transport.asciidoc
index b7ec6d2..2d59e82 100644
--- a/doc/src/manual/ranch_transport.asciidoc
+++ b/doc/src/manual/ranch_transport.asciidoc
@@ -138,12 +138,16 @@ Return the name of the transport.
----
peername(Socket :: socket())
-> {ok, {inet:ip_address(), inet:port_number()}}
- | {error, atom()}.
+ | {local, binary()} | {error, atom()}.
----
Return the address and port number for the other end of
the connection.
+For UNIX Domain sockets the return value will be
+`{local, PeerSocket}`, with `PeerSocket` typically
+an empty binary.
+
=== recv
[source,erlang]
@@ -250,6 +254,9 @@ sockname(Socket :: socket())
Return the address and port number for the local end
of the connection.
+For UNIX Domain sockets the return value will be
+`{local, SocketFile}`.
+
== Exports
The following function can be used when implementing