diff options
| author | Ingela Anderton Andin <[email protected]> | 2014-10-13 12:28:12 +0200 |
|---|---|---|
| committer | Ingela Anderton Andin <[email protected]> | 2014-10-13 12:28:12 +0200 |
| commit | d2f700dea89d43edeb0a41d2ddfb64d9a4c20004 (patch) | |
| tree | 1446f3477aa8142b072bf58cf7dd760843025d70 /lib/ssl/doc | |
| parent | 527922fc932fff13a6a2bed7f13de4148e26885f (diff) | |
| parent | a60c126e813cdef73ff6fbd4dc5414f385d2c8c6 (diff) | |
| download | otp-d2f700dea89d43edeb0a41d2ddfb64d9a4c20004.tar.gz otp-d2f700dea89d43edeb0a41d2ddfb64d9a4c20004.tar.bz2 otp-d2f700dea89d43edeb0a41d2ddfb64d9a4c20004.zip | |
Merge branch 'ia/ssl/seperate-clinet-server-session-table/OTP-11365'
* ia/ssl/seperate-clinet-server-session-table/OTP-11365:
ssl: Separate session cache for client and server
Diffstat (limited to 'lib/ssl/doc')
| -rw-r--r-- | lib/ssl/doc/src/ssl_app.xml | 6 | ||||
| -rw-r--r-- | lib/ssl/doc/src/ssl_session_cache_api.xml | 20 |
2 files changed, 17 insertions, 9 deletions
diff --git a/lib/ssl/doc/src/ssl_app.xml b/lib/ssl/doc/src/ssl_app.xml index 43cb3934f7..c8024548b5 100644 --- a/lib/ssl/doc/src/ssl_app.xml +++ b/lib/ssl/doc/src/ssl_app.xml @@ -4,7 +4,7 @@ <appref> <header> <copyright> - <year>1999</year><year>2013</year> + <year>1999</year><year>2014</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -75,10 +75,10 @@ </p> </item> - <tag><c><![CDATA[session_cb_init_args = list() <optional>]]></c></tag> + <tag><c><![CDATA[session_cb_init_args = proplist:proplist() <optional>]]></c></tag> <item> <p> - List of arguments to the init function in session cache + List of additional user defined arguments to the init function in session cache callback module, defaults to []. </p> </item> diff --git a/lib/ssl/doc/src/ssl_session_cache_api.xml b/lib/ssl/doc/src/ssl_session_cache_api.xml index 82de1784ca..cb97bbfbb2 100644 --- a/lib/ssl/doc/src/ssl_session_cache_api.xml +++ b/lib/ssl/doc/src/ssl_session_cache_api.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>1999</year><year>2013</year> + <year>1999</year><year>2014</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -79,17 +79,25 @@ </func> <func> - <name>init() -> opaque() </name> + <name>init(Args) -> opaque() </name> <fsummary>Return cache reference</fsummary> <type> - <v></v> + <v>Args = proplists:proplist()</v> + <d>Will always include the property {role, client | server}. Currently this + is the only predefined property, there may also be user defined properties. + <seealso marker="ssl_app"> See also application environment variable + session_cb_init_args</seealso> + </d> </type> <desc> <p>Performs possible initializations of the cache and returns a reference to it that will be used as parameter to the other - api functions. Will be called by the cache handling processes - init function, hence putting the same requirements on it as - a normal process init function. + API functions. Will be called by the cache handling processes + init function, hence putting the same requirements on it as a + normal process init function. Note that this function will be + called twice when starting the ssl application, once with the + role client and once with the role server, as the ssl application + must be prepared to take on both roles. </p> </desc> </func> |