aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorJan Uhlig <[email protected]>2017-11-07 14:17:35 +0100
committerLoïc Hoguin <[email protected]>2018-01-22 15:48:08 +0100
commitb6f5b70ddbd7cb29cc26012e224fbbac67ca0432 (patch)
treea81cc626a62ac3cb5c756fba608addc831be83a6 /doc/src
parentf7934bfaecb8351553a3e12bbaba7180b927a0e8 (diff)
downloadranch-b6f5b70ddbd7cb29cc26012e224fbbac67ca0432.tar.gz
ranch-b6f5b70ddbd7cb29cc26012e224fbbac67ca0432.tar.bz2
ranch-b6f5b70ddbd7cb29cc26012e224fbbac67ca0432.zip
Added transport functions getopts/2, getstat/1 and getstat/2
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/manual/ranch_transport.asciidoc23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/src/manual/ranch_transport.asciidoc b/doc/src/manual/ranch_transport.asciidoc
index a9322f4..cbcea42 100644
--- a/doc/src/manual/ranch_transport.asciidoc
+++ b/doc/src/manual/ranch_transport.asciidoc
@@ -160,6 +160,29 @@ Change options for the given socket.
This is mainly useful for switching to active or passive mode
or to set protocol-specific options.
+=== getopts(CSocket, SockOpts) -> {ok, SockOptValues} | {error, atom()}
+
+CSocket = any():: Socket for this connection.
+SockOpts = [atom]:: Socket option names.
+SockOptValues = list():: Socket options.
+
+Get options for the given socket.
+
+=== getstat(CSocket) -> {ok, SockStatValues} | {error, atom()}
+
+CSocket = any():: Socket for this connection.
+SockStatValues = list():: Socket statistics.
+
+Get statistics for the given socket.
+
+=== getstat(CSocket, SockStats) -> {ok, SockStatValues} | {error, atom()}
+
+CSocket = any():: Socket for this connection.
+SockStats = [atom()]:: Socket statistic names.
+SockStatValues = list():: Socket statistics.
+
+Get statistics for the given socket.
+
=== shutdown(CSocket, How) -> ok | {error, atom()}
CSocket = any():: Socket for this connection.