---
name: "Eliom_state.Session_admin.server"
section: "3o"
platform: "linux"
package: "libeliom-ocaml-doc"
version: "2.2.2-1"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/Eliom_state.Session_admin.server"
---

# Eliom\_state.Session\_admin.server(3o)

no description

## NAME

Eliom\_state.Session\_admin - no description

## Module

Module   Eliom\_state.Session\_admin

## Documentation

Module **Session\_admin**\
  :  **sig end**

*type timeout* =\
  \| TGlobal  (\* see global setting \*)\
  \| TNone  (\* explicitly set no timeout \*)\
  \| TSome **of** **float**

Type used to describe session timeouts

*type service\_session*

timeout duration in seconds

*type data\_session*

*type persistent\_session*

*val close\_service\_session* :  **?close\_group:bool -\>** **session:service\_session -\> unit**

*val close\_volatile\_data\_session* :  **?close\_group:bool -\> session:data\_session -\> unit**

*val close\_persistent\_data\_session* :  **?close\_group:bool -\>** **session:persistent\_session -\> unit Lwt.t**

*val get\_volatile\_session\_data* :  **session:data\_session -\>** **table:'a Eliom\_state.volatile\_table -\> 'a**

Raises  **Not\_found** if no data in the table for the session.

*val get\_persistent\_session\_data* :  **session:persistent\_session -\>** **table:'a Eliom\_state.persistent\_table -\> 'a Lwt.t**

Fails with lwt exception  **Not\_found** if no data in the table for the session.

*val remove\_volatile\_session\_data* :  **session:data\_session -\>** **table:'a Eliom\_state.volatile\_table -\> unit**

*val remove\_persistent\_session\_data* :  **session:persistent\_session -\>** **table:'a Eliom\_state.persistent\_table -\> unit Lwt.t**

*val get\_service\_scope\_name* :  **session:service\_session -\> Eliom\_common.scope\_name**

*val get\_volatile\_data\_scope\_name* :  **session:data\_session -\> Eliom\_common.scope\_name**

*val get\_persistent\_data\_scope\_name* :  **session:persistent\_session -\>** **Eliom\_common.scope\_name**

*val get\_service\_session\_cookie\_scope* :  **session:service\_session -\>** **Eliom\_common.cookie\_scope**

*val get\_volatile\_data\_session\_cookie\_scope* :  **session:data\_session -\> Eliom\_common.cookie\_scope**

*val get\_persistent\_data\_session\_cookie\_scope* :  **session:persistent\_session -\>** **Eliom\_common.cookie\_scope**

*val set\_service\_session\_timeout* :  **session:service\_session -\> float option -\> unit**

*val set\_volatile\_data\_session\_timeout* :  **session:data\_session -\> float option -\> unit**

*val set\_persistent\_data\_session\_timeout* :  **session:persistent\_session -\>** **float option -\> unit Lwt.t**

*val get\_service\_session\_timeout* :  **session:service\_session -\>** **timeout**

*val get\_volatile\_data\_session\_timeout* :  **session:data\_session -\>** **timeout**

*val get\_persistent\_data\_session\_timeout* :  **session:persistent\_session -\>** **timeout**

*val unset\_service\_session\_timeout* :  **session:service\_session -\> unit**

*val unset\_volatile\_data\_session\_timeout* :  **session:data\_session -\> unit**

*val unset\_persistent\_data\_session\_timeout* :  **session:persistent\_session -\> unit Lwt.t**

*val iter\_service\_sessions* :  **(service\_session -\> unit Lwt.t) -\> unit Lwt.t**

Iterator on service sessions.  **Lwt\_unix.yield** is called automatically after each iteration.

*val iter\_volatile\_data\_sessions* :  **(data\_session -\> unit Lwt.t) -\> unit Lwt.t**

Iterator on data sessions.  **Lwt\_unix.yield** is called automatically after each iteration.

*val iter\_persistent\_data\_sessions* :  **(persistent\_session -\> unit Lwt.t) -\> unit Lwt.t**

Iterator on persistent sessions.  **Lwt\_unix.yield** is called automatically after each iteration.

*val fold\_service\_sessions* :  **(service\_session -\> 'a -\> 'a Lwt.t) -\>** **'a -\> 'a Lwt.t**

Iterator on service sessions.  **Lwt\_unix.yield** is called automatically after each iteration.

*val fold\_volatile\_data\_sessions* :  **(data\_session -\> 'a -\> 'a Lwt.t) -\> 'a -\> 'a Lwt.t**

Iterator on data sessions.  **Lwt\_unix.yield** is called automatically after each iteration.

*val fold\_persistent\_data\_sessions* :  **(persistent\_session -\> 'a -\> 'a Lwt.t) -\>** **'a -\> 'a Lwt.t**

Iterator on persistent sessions.  **Lwt\_unix.yield** is called automatically after each iteration.