aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-12-23 12:00:08 +0100
committerIngela Anderton Andin <[email protected]>2016-06-09 10:04:06 +0200
commit84fd2c325c9e38b5ea2307b6133c3d15b33a3241 (patch)
treeff12089d8cd97a8a9a709af24c90233fe0a8fafa /lib/ssl/doc
parent26a79bc4e9b399e326238ff74db0ee99a654352d (diff)
downloadotp-84fd2c325c9e38b5ea2307b6133c3d15b33a3241.tar.gz
otp-84fd2c325c9e38b5ea2307b6133c3d15b33a3241.tar.bz2
otp-84fd2c325c9e38b5ea2307b6133c3d15b33a3241.zip
Add ssl:getstat/1 and ssl:getstat/2
These functions call getstat on the underlying TCP socket. The only way to do this before now was to use a hack, either by looking inside the #sslsocket{} record directly, or by not using the SSL listen/accept functions and upgrading from a TCP socket that is kept around for the purpose of calling getstat later on.
Diffstat (limited to 'lib/ssl/doc')
-rw-r--r--lib/ssl/doc/src/ssl.xml17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 62f6263e9e..bed82cdb91 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -901,6 +901,23 @@ fun(srp, Username :: string(), UserState :: term()) ->
</func>
<func>
+ <name>getstat(Socket) ->
+ {ok, OptionValues} | {error, inet:posix()}</name>
+ <name>getstat(Socket, OptionNames) ->
+ {ok, OptionValues} | {error, inet:posix()}</name>
+ <fsummary>Get one or more statistic options for a socket</fsummary>
+ <type>
+ <v>Socket = sslsocket()</v>
+ <v>OptionNames = [atom()]</v>
+ <v>OptionValues = [{inet:stat_option(), integer()}]</v>
+ </type>
+ <desc>
+ <p>Gets one or more statistic options for the underlying TCP socket.</p>
+ <p>See inet:getstat/2 for statistic options description.</p>
+ </desc>
+ </func>
+
+ <func>
<name>listen(Port, Options) ->
{ok, ListenSocket} | {error, Reason}</name>
<fsummary>Creates an SSL listen socket.</fsummary>