package session-cohttp

You can search for identifiers within the package.

in-package search v0.2.0

session-cohttp
- Session_cohttp
  - Backend
  - Make
    
    B
    
    IO
  - S

Legend:
Library
Module
Module type
Parameter
Class
Class type

type +'a io = 'a IO.t

The type of a blocking computation that will produce a value of type 'a

type t

The type of a handle on the backend.

type key = string

The type of a session key.

type value = string

The type of a session value.

type period = int64

The type of a session expiry period.

val default_period : t -> period

default_period t returns default period after which session keys will expire. Depending on the backend, this value may vary over time.

val generate : ?expiry:period -> ?value:value -> t -> key io

generate ?expiry ?value t will allocate a new session in the backend t and return its associated key. The session will expire expiry seconds from now, defaulting to default_period t if one is not explicitly specified.

The key should be unique, though it may not be in order to allow implementations that use randomness or hashing to conform to this interface.

val clear : t -> key -> unit io

clear t key removes key from the backend t. The backend may choose to persist the session value beyond this call. If it does any subsequent operations involving key behave as if it was not there.

val get : t -> key -> (value * period, Session.S.error) Stdlib.result io

get t key returns the session value, if present and unexpired, together with its expiry period as of now.

val set : ?expiry:period -> t -> key -> value -> unit io

set ?expiry t key value sets the value for the session associated key in backend t and sets the session to expire expiry seconds from now. If expiry is not provided, the expiry period reported by default_period t will be used instead.