diff options
Diffstat (limited to 'meta/3rd/OpenResty/library/ngx.ssl.session.lua')
| -rw-r--r-- | meta/3rd/OpenResty/library/ngx.ssl.session.lua | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/meta/3rd/OpenResty/library/ngx.ssl.session.lua b/meta/3rd/OpenResty/library/ngx.ssl.session.lua index 08c53df9..7307b00c 100644 --- a/meta/3rd/OpenResty/library/ngx.ssl.session.lua +++ b/meta/3rd/OpenResty/library/ngx.ssl.session.lua @@ -8,11 +8,11 @@ session.version = require("resty.core.base").version --- If the SSL session is successfully set, the current SSL connection can resume the session --- directly without going through the full SSL handshake process (which is very expensive in terms of CPU time). --- ---- This API is usually used in the context of [ssl_session_fetch_by_lua*](https://github.com/openresty/lua-nginx-module#ssl_session_fetch_by_lua_block) +--- This API is usually used in the context of `ssl_session_fetch_by_lua*` --- when a cache hit is found with the current SSL session ID. --- --- The serialized SSL session used as the argument should be originally returned by the ---- [get_serialized_session](#get_serialized_session) function. +--- `get_serialized_session` function. --- ---@param session string ---@return boolean ok @@ -21,17 +21,16 @@ function session.set_serialized_session(session) end --- Returns the serialized form of the SSL session data of the current SSL connection, in a Lua string. --- ---- This session can be cached in [lua-resty-lrucache](https://github.com/openresty/lua-resty-lrucache), [lua_shared_dict](https://github.com/openresty/lua-nginx-module#lua_shared_dict), +--- This session can be cached in `lua-resty-lrucache`, `lua_shared_dict`, --- and/or external data storage services like `memcached` and `redis`. The SSL session ID returned ---- by the [get_session_id](#get_session_id) function is usually used as the cache key. +--- by the `get_session_id` function is usually used as the cache key. --- --- The returned SSL session data can later be loaded into other SSL connections using the same ---- session ID via the [set_serialized_session](#set_serialized_session) function. +--- session ID via the `set_serialized_session` function. --- --- In case of errors, it returns `nil` and a string describing the error. --- ---- This API function is usually called in the context of ---- [ssl_session_store_by_lua*](https://github.com/openresty/lua-nginx-module#ssl_session_store_by_lua_block) +--- This API function is usually called in the context of `ssl_session_store_by_lua*` --- where the SSL handshake has just completed. --- ---@return string? session @@ -44,8 +43,7 @@ function session.get_serialized_session() end --- In case of errors, it returns `nil` and a string describing the error. --- --- This API function is usually called in the contexts of ---- [ssl_session_store_by_lua*](https://github.com/openresty/lua-nginx-module/#ssl_session_store_by_lua_block) ---- and [ssl_session_fetch_by_lua*](https://github.com/openresty/lua-nginx-module/#ssl_session_fetch_by_lua_block). +--- `ssl_session_store_by_lua*` and `ssl_session_fetch_by_lua*`. --- ---@return string? id ---@return string? error |