• Installing/Configuring
  • Installation

  • Installation
  • Installation


    Information for installing this PECL extension may
    be found in the manual chapter titled Installation of PECL extensions. Additional
    information such as new releases, downloads, source files,
    maintainer information, and a CHANGELOG, can be located here:

    Configure options

    • –with-tokyo-tyrant[=DIR] DIR is the
      prefix to the Tokyo Tyrant installation
    • –with-tokyo-cabinet-dir[=DIR] DIR is
      the prefix to the Tokyo Cabinet installation
    • –disable-tokyo-tyrant-session Disable
      Tokyo Tyrant session handler support

    Enabling the extension

    The extension can be enabled by adding to the INI-configuration

    Running Tokyo Tyrant for the session handler

    ttserver -port 2000 -ext /path/to/expire.lua
    -extpc expire 30.0 ‘/tmp/sessions.tct#idx=ts:dec’

    Note: expire.lua is included in the tokyo_tyrant extension
    source distribution

    Configuring session handler

    • tokyo_tyrant.session_salt=”randomlongstring”
    • session.save_handler=tokyo_tyrant
    • session.save_path=”tcp://hostname1:2000,tcp://hostname2:2000″

    Note: It is
    important to make sure that tokyo_tyrant.session_salt matches on all

    How it works?

    The session handler creates a session id like the

    The parts from left to right:

    • Session id – Generated session id
    • Checksum – Checksum of session salt,
      session id, node id and primary key
    • Node id – The id of the node where the
      session maps to
    • Primary key – The primary key of the
      row where the session is stored

    The checksum contains SHA1 sum of the node id,
    primary key, session id and the salt which is known only on the
    server side. This allows quick mapping of session id to node and
    primary key since there is no need to do an additional search.
    During session id regeneration only the parts 1 and 2 change but
    the mapping to the node and primary key stays constant.

    In case some of the nodes fail tokyo_tyrant.allow_failover, tokyo_tyrant.fail_threshold and tokyo_tyrant.health_check_divisor INI-settings
    control the behavior during failover. If failover is allowed the
    session handler will map the session to a healthy node and creates
    a new empty session.