From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/ssl/doc/src/ssl.xml | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) (limited to 'lib/ssl/doc') diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index e13393bf63..b4aa8746f9 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -28,7 +28,7 @@ ssl.xml - ssl + ssl Interface Functions for Secure Socket Layer

@@ -939,7 +939,7 @@ fun(srp, Username :: string(), UserState :: term()) -> connect(Socket, SslOptions) -> - connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} + connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} Upgrades a gen_tcp, or equivalent, connected socket to an TLS socket. @@ -975,8 +975,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - connect(Host, Port, Options) -> - connect(Host, Port, Options, Timeout) -> + connect(Host, Port, Options) -> + connect(Host, Port, Options, Timeout) -> {ok, SslSocket}| {ok, SslSocket, Ext} | {error, Reason} Opens an TLS/DTLS connection to Host, Port. @@ -1018,7 +1018,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - close(SslSocket) -> ok | {error, Reason} + close(SslSocket) -> ok | {error, Reason} Closes an TLS/DTLS connection. SslSocket = sslsocket() @@ -1044,7 +1044,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - controlling_process(SslSocket, NewOwner) -> + controlling_process(SslSocket, NewOwner) -> ok | {error, Reason} Assigns a new controlling process to the TLS/DTLS socket. @@ -1118,7 +1118,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - format_error(Reason) -> string() + format_error(Reason) -> string() Returns an error string. Reason = term() @@ -1129,7 +1129,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - getopts(SslSocket, OptionNames) -> + getopts(SslSocket, OptionNames) -> {ok, [socketoption()]} | {error, Reason} Gets the values of the specified options. @@ -1240,7 +1240,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - listen(Port, Options) -> + listen(Port, Options) -> {ok, ListenSocket} | {error, Reason} Creates an SSL listen socket. @@ -1268,7 +1268,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - peercert(SslSocket) -> {ok, Cert} | {error, Reason} + peercert(SslSocket) -> {ok, Cert} | {error, Reason} Returns the peer certificate. SslSocket = sslsocket() @@ -1283,7 +1283,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - peername(SslSocket) -> {ok, {Address, Port}} | + peername(SslSocket) -> {ok, {Address, Port}} | {error, Reason} Returns the peer address and port. @@ -1333,8 +1333,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - recv(SslSocket, Length) -> - recv(SslSocket, Length, Timeout) -> {ok, Data} | {error, + recv(SslSocket, Length) -> + recv(SslSocket, Length, Timeout) -> {ok, Data} | {error, Reason} Receives data on a socket. @@ -1373,7 +1373,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - send(SslSocket, Data) -> ok | {error, Reason} + send(SslSocket, Data) -> ok | {error, Reason} Writes data to a socket. SslSocket = sslsocket() @@ -1387,7 +1387,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - setopts(SslSocket, Options) -> ok | {error, Reason} + setopts(SslSocket, Options) -> ok | {error, Reason} Sets socket options. SslSocket = sslsocket() @@ -1418,8 +1418,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - ssl_accept(SslSocket) -> - ssl_accept(SslSocket, Timeout) -> ok | {error, Reason} + ssl_accept(SslSocket) -> + ssl_accept(SslSocket, Timeout) -> ok | {error, Reason} Performs server-side SSL/TLS handshake. SslSocket = sslsocket() @@ -1433,7 +1433,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - ssl_accept(Socket, SslOptions) -> + ssl_accept(Socket, SslOptions) -> ssl_accept(Socket, SslOptions, Timeout) -> {ok, Socket} | ok | {error, Reason} Performs server-side SSL/TLS/DTLS handshake. @@ -1449,7 +1449,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - sockname(SslSocket) -> {ok, {Address, Port}} | + sockname(SslSocket) -> {ok, {Address, Port}} | {error, Reason} Returns the local address and port. @@ -1497,8 +1497,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - transport_accept(ListenSocket) -> - transport_accept(ListenSocket, Timeout) -> + transport_accept(ListenSocket) -> + transport_accept(ListenSocket, Timeout) -> {ok, SslSocket} | {error, Reason} Accepts an incoming connection and prepares for ssl_accept. -- cgit v1.2.3