3.5 library(http/http_session): HTTP Session management
AllApplicationManualNameSummaryHelp

  • Documentation
    • Reference manual
    • Packages
      • SWI-Prolog HTTP support
        • The HTTP server libraries
          • library(http/http_session): HTTP Session management
            • http_set_session_options/1
            • http_session_option/1
            • http_set_session/1
            • http_set_session/2
            • http_session_id/1
            • http_in_session/1
            • http_open_session/2
            • http_session_asserta/1
            • http_session_assert/1
            • http_session_retract/1
            • http_session_retractall/1
            • http_session_data/1
            • http_session_asserta/2
            • http_session_assert/2
            • http_session_retract/2
            • http_session_retractall/2
            • http_session_data/2
            • http_current_session/2
            • http_close_session/1
            • http_session_cookie/1
Availability::- use_module(library(http/http_session)).
Source[det]http_set_session_options(+Options)
Set options for the session library. Provided options are:
timeout(+Seconds)
Session timeout in seconds. Default is 600 (10 min). A timeout of 0 (zero) disables timeout.
cookie(+Cookiekname)
Name to use for the cookie to identify the session. Default swipl_session.
path(+Path)
Path to which the cookie is associated. Default is /. Cookies are only sent if the HTTP request path is a refinement of Path.
route(+Route)
Set the route name. Default is the unqualified hostname. To cancel adding a route, use the empty atom. See route/1.
enabled(+Boolean)
Enable/disable session management. Sesion management is enabled by default after loading this file.
create(+Atom)
Defines when a session is created. This is one of auto (default), which creates a session if there is a request whose path matches the defined session path or noauto, in which cases sessions are only created by calling http_open_session/2 explicitely.
proxy_enabled(+Boolean)
Enable/disable proxy session management. Proxy session management associates the originating IP address of the client to the session rather than the proxy IP address. Default is false.
gc(+When)
When is one of active, which starts a thread that performs session cleanup at close to the moment of the timeout or passive, which runs session GC when a new session is created.