From b6f5b70ddbd7cb29cc26012e224fbbac67ca0432 Mon Sep 17 00:00:00 2001 From: Jan Uhlig Date: Tue, 7 Nov 2017 14:17:35 +0100 Subject: Added transport functions getopts/2, getstat/1 and getstat/2 --- doc/src/manual/ranch_transport.asciidoc | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'doc') 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. -- cgit v1.2.3