Skip to content

Commit

Permalink
docs: add user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Feb 24, 2024
1 parent 5fd0893 commit 1f5dc0d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
5 changes: 5 additions & 0 deletions user_guide_src/source/changelogs/v4.5.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,11 @@ Libraries
- The ``$dbGroup`` parameter of ``Validation::run()`` now accepts not only
a database group name, but also a database connection instance or an array
of database settings.
- **Session:**
- ``RedisHandler`` now can configure the interval time for acquiring locks
(``$lockRetryInterval``) and the number of retries (``$lockMaxRetries``).
- Now you can use Redis ACL (username and password) with ``RedisHandler``.
See :ref:`sessions-redishandler-driver` for details.

Helpers and Functions
=====================
Expand Down
12 changes: 11 additions & 1 deletion user_guide_src/source/libraries/sessions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,9 @@ RedisHandler Driver

.. note:: Since Redis doesn't have a locking mechanism exposed, locks for
this driver are emulated by a separate value that is kept for up
to 300 seconds. With ``v4.3.2`` or above, you can connect ``Redis`` with **TLS** protocol.
to 300 seconds.

.. note:: Starting with v4.3.2, you can connect Redis with **TLS** protocol.

Redis is a storage engine typically used for caching and popular because
of its high performance, which is also probably your reason to use the
Expand Down Expand Up @@ -715,6 +717,14 @@ sufficient:

.. _sessions-memcachedhandler-driver:

Starting with v4.5.0, you can use Redis ACL (username and password)::

public string $savePath = 'tcp://localhost:6379?auth[user]=username&auth[pass]=password';

.. note:: Starting with v4.5.0, the interval time for acquiring locks
(``$lockRetryInterval``) and the number of retries (``$lockMaxRetries``) are
configurable.

MemcachedHandler Driver
=======================

Expand Down

0 comments on commit 1f5dc0d

Please sign in to comment.