From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Tue, 11 Dec 2018 17:42:39 +0100 Subject: Add "since" attributes in xml for new functions and modules introduced after OTP_R13B03. --- lib/ssl/doc/src/ssl.xml | 64 +++++++++++++++---------------- lib/ssl/doc/src/ssl_crl_cache.xml | 8 ++-- lib/ssl/doc/src/ssl_crl_cache_api.xml | 10 ++--- lib/ssl/doc/src/ssl_session_cache_api.xml | 18 ++++----- 4 files changed, 50 insertions(+), 50 deletions(-) (limited to 'lib/ssl/doc') diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index 3029977745..e13393bf63 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -873,7 +873,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - append_cipher_suites(Deferred, Suites) -> ciphers() + append_cipher_suites(Deferred, Suites) -> ciphers() Deferred = ciphers() | cipher_filters() @@ -889,8 +889,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - cipher_suites() -> - cipher_suites(Type) -> old_ciphers() + cipher_suites() -> + cipher_suites(Type) -> old_ciphers() Returns a list of supported cipher suites. Type = erlang | openssl | all @@ -901,7 +901,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - cipher_suites(Supported, Version) -> ciphers() + cipher_suites(Supported, Version) -> ciphers() Returns a list of all default or all supported cipher suites. @@ -915,8 +915,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - eccs() -> - eccs(protocol_version()) -> [named_curve()] + eccs() -> + eccs(protocol_version()) -> [named_curve()] Returns a list of supported ECCs.

Returns a list of supported ECCs. eccs() @@ -926,7 +926,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - clear_pem_cache() -> ok + clear_pem_cache() -> ok Clears the pem cache

PEM files, used by ssl API-functions, are cached. The @@ -938,7 +938,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - connect(Socket, SslOptions) -> + connect(Socket, SslOptions) -> connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} Upgrades a gen_tcp, or @@ -1029,7 +1029,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - close(SslSocket, How) -> ok | {ok, port()} | {error, Reason} + close(SslSocket, How) -> ok | {ok, port()} | {error, Reason} Closes an TLS connection. SslSocket = sslsocket() @@ -1060,7 +1060,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - connection_information(SslSocket) -> + connection_information(SslSocket) -> {ok, Result} | {error, Reason} Returns all the connection information. @@ -1081,7 +1081,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - connection_information(SslSocket, Items) -> + connection_information(SslSocket, Items) -> {ok, Result} | {error, Reason} Returns the requested connection information. @@ -1103,7 +1103,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - filter_cipher_suites(Suites, Filters) -> ciphers() + filter_cipher_suites(Suites, Filters) -> ciphers() Suites = ciphers() @@ -1143,9 +1143,9 @@ fun(srp, Username :: string(), UserState :: term()) -> - getstat(SslSocket) -> + getstat(SslSocket) -> {ok, OptionValues} | {error, inet:posix()} - getstat(SslSocket, OptionNames) -> + getstat(SslSocket, OptionNames) -> {ok, OptionValues} | {error, inet:posix()} Get one or more statistic options for a socket @@ -1160,8 +1160,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake(HsSocket) -> - handshake(HsSocket, Timeout) -> {ok, SslSocket} | {error, Reason} + handshake(HsSocket) -> + handshake(HsSocket, Timeout) -> {ok, SslSocket} | {error, Reason} Performs server-side SSL/TLS handshake. HsSocket = SslSocket = sslsocket() @@ -1175,8 +1175,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake(Socket, SslOptions) -> - handshake(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} + handshake(Socket, SslOptions) -> + handshake(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} Performs server-side SSL/TLS/DTLS handshake. Socket = socket() | sslsocket() @@ -1214,7 +1214,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake_cancel(SslSocket) -> ok + handshake_cancel(SslSocket) -> ok Cancel handshake with a fatal alert SslSocket = sslsocket() @@ -1225,8 +1225,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake_continue(HsSocket, SSLOptions) -> {ok, SslSocket} | {error, Reason} - handshake_continue(HsSocket, SSLOptions, Timeout) -> {ok, SslSocket} | {error, Reason} + handshake_continue(HsSocket, SSLOptions) -> {ok, SslSocket} | {error, Reason} + handshake_continue(HsSocket, SSLOptions, Timeout) -> {ok, SslSocket} | {error, Reason} Continue the SSL/TLS handshake. HsSocket = SslSocket = sslsocket() @@ -1254,7 +1254,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - negotiated_protocol(SslSocket) -> {ok, Protocol} | {error, protocol_not_negotiated} + negotiated_protocol(SslSocket) -> {ok, Protocol} | {error, protocol_not_negotiated} Returns the protocol negotiated through ALPN or NPN extensions. SslSocket = sslsocket() @@ -1297,7 +1297,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - prepend_cipher_suites(Preferred, Suites) -> ciphers() + prepend_cipher_suites(Preferred, Suites) -> ciphers() Preferred = ciphers() | cipher_filters() @@ -1313,7 +1313,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - prf(Socket, Secret, Label, Seed, WantedLength) -> {ok, binary()} | {error, reason()} + prf(Socket, Secret, Label, Seed, WantedLength) -> {ok, binary()} | {error, reason()} Uses a session Pseudo-Random Function to generate key material. Socket = sslsocket() @@ -1360,7 +1360,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - renegotiate(SslSocket) -> ok | {error, Reason} + renegotiate(SslSocket) -> ok | {error, Reason} Initiates a new handshake. SslSocket = sslsocket() @@ -1400,7 +1400,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - shutdown(SslSocket, How) -> ok | {error, Reason} + shutdown(SslSocket, How) -> ok | {error, Reason} Immediately closes a socket. SslSocket = sslsocket() @@ -1434,7 +1434,7 @@ fun(srp, Username :: string(), UserState :: term()) -> ssl_accept(Socket, SslOptions) -> - ssl_accept(Socket, SslOptions, Timeout) -> {ok, Socket} | ok | {error, Reason} + ssl_accept(Socket, SslOptions, Timeout) -> {ok, Socket} | ok | {error, Reason} Performs server-side SSL/TLS/DTLS handshake. Socket = socket() | sslsocket() @@ -1464,8 +1464,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - start() -> - start(Type) -> ok | {error, Reason} + start() -> + start(Type) -> ok | {error, Reason} Starts the SSL application. Type = permanent | transient | temporary @@ -1477,7 +1477,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - stop() -> ok + stop() -> ok Stops the SSL application.

Stops the SSL application.

@@ -1485,7 +1485,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - suite_to_str(CipherSuite) -> String + suite_to_str(CipherSuite) -> String Returns the string representation of a cipher suite. CipherSuite = erl_cipher_suite() @@ -1532,7 +1532,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - versions() -> [versions_info()] + versions() -> [versions_info()] Returns version information relevant for the SSL application. diff --git a/lib/ssl/doc/src/ssl_crl_cache.xml b/lib/ssl/doc/src/ssl_crl_cache.xml index 71c6d5e49e..b766cfd2d9 100644 --- a/lib/ssl/doc/src/ssl_crl_cache.xml +++ b/lib/ssl/doc/src/ssl_crl_cache.xml @@ -24,7 +24,7 @@ ssl_crl_cache.xml - ssl_crl_cache + ssl_crl_cache CRL cache

@@ -37,7 +37,7 @@ - delete(Entries) -> ok | {error, Reason} + delete(Entries) -> ok | {error, Reason} Entries = uri_string:uri_string() | {file, string()} | {der, [ - insert(CRLSrc) -> ok | {error, Reason} - insert(URI, CRLSrc) -> ok | {error, Reason} + insert(CRLSrc) -> ok | {error, Reason} + insert(URI, CRLSrc) -> ok | {error, Reason} CRLSrc = {file, string()} | {der, [ ssl_crl_cache_api.xml - ssl_crl_cache_api + ssl_crl_cache_api API for a SSL/TLS CRL (Certificate Revocation List) cache.

@@ -59,7 +59,7 @@ - fresh_crl(DistributionPoint, CRL) -> FreshCRL + fresh_crl(DistributionPoint, CRL) -> FreshCRL fun fresh_crl/2 will be used as input option update_crl to public_key:pkix_crls_validate/3 @@ -76,8 +76,8 @@ - lookup(DistributionPoint, Issuer, DbHandle) -> not_available | CRLs - lookup(DistributionPoint, DbHandle) -> not_available | CRLs + lookup(DistributionPoint, Issuer, DbHandle) -> not_available | CRLs + lookup(DistributionPoint, DbHandle) -> not_available | CRLs DistributionPoint = dist_point() @@ -106,7 +106,7 @@ - select(Issuer, DbHandle) -> CRLs + select(Issuer, DbHandle) -> CRLs Select the CRLs in the cache that are issued by Issuer Issuer = ssl_session_cache_api.xml - ssl_session_cache_api + ssl_session_cache_api TLS session cache API @@ -66,7 +66,7 @@ - delete(Cache, Key) -> _ + delete(Cache, Key) -> _ Deletes a cache entry. Cache = cache_ref() @@ -80,7 +80,7 @@ - foldl(Fun, Acc0, Cache) -> Acc + foldl(Fun, Acc0, Cache) -> Acc @@ -96,7 +96,7 @@ - init(Args) -> opaque() + init(Args) -> opaque() Returns cache reference. Args = proplists:proplist() @@ -121,7 +121,7 @@ - lookup(Cache, Key) -> Entry + lookup(Cache, Key) -> Entry Looks up a cache entry. Cache = cache_ref() @@ -136,7 +136,7 @@ - select_session(Cache, PartialKey) -> [session()] + select_session(Cache, PartialKey) -> [session()] Selects sessions that can be reused. Cache = cache_ref() @@ -151,7 +151,7 @@ - size(Cache) -> integer() + size(Cache) -> integer() Returns the number of sessions in the cache. Cache = cache_ref() @@ -166,7 +166,7 @@ - terminate(Cache) -> _ + terminate(Cache) -> _ Called by the process that handles the cache when it is about to terminate. @@ -180,7 +180,7 @@ - update(Cache, Key, Session) -> _ + update(Cache, Key, Session) -> _ Caches a new session or updates an already cached one. Cache = cache_ref() -- cgit v1.2.3 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