package ocsigenserver

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Persistent references
Persistent tables

ocsigenserver
ocsigenserver.baselib
- Dynlink_wrapper
- Ocsigen_cache
  - Dlist
  - Make
    
    A
    
    cache
- Ocsigen_config_static
- Ocsigen_lib
  - Clist
  - Filename
  - Int
  - Ip_address
  - List
  - Option
    
    Lwt
  - Printexc
    
    Slot
  - String
    
    Map
    
    Set
    
    Table
  - String_base
  - Tuple3
  - Url
  - Url_base
- Ocsigen_loader
- Ocsigen_stream
  - StringStream
ocsigenserver.baselib.base
- Ocsigen_lib_base
  - Clist
  - Int
  - List
  - Option
    
    Lwt
  - Printexc
    
    Slot
  - String_base
  - Tuple3
  - Url_base
ocsigenserver.cookies
- Ocsigen_cookie_map
  - Poly
ocsigenserver.ext.accesscontrol
- Accesscontrol
ocsigenserver.ext.authbasic
- Authbasic
ocsigenserver.ext.cors
- Cors
ocsigenserver.ext.deflatemod
- Deflatemod
ocsigenserver.ext.extendconfiguration
- Extendconfiguration
ocsigenserver.ext.ocsipersist-dbm
- Ocsipersist
  - COLUMN
  - Column
    
    Float
    
    Marshal
    
    C
    
    String
  - TABLE
  - TABLE_CONF
  - Table
    
    Key
    
    T
    
    Value
ocsigenserver.ext.ocsipersist-pgsql
- Ocsipersist
  - COLUMN
  - Column
    
    Float
    
    Marshal
    
    C
    
    String
  - TABLE
  - TABLE_CONF
  - Table
    
    Key
    
    T
    
    Value
ocsigenserver.ext.outputfilter
- Outputfilter
ocsigenserver.ext.redirectmod
- Redirectmod
ocsigenserver.ext.revproxy
- Revproxy
ocsigenserver.ext.rewritemod
- Rewritemod
ocsigenserver.ext.staticmod
- Staticmod
ocsigenserver.ext.userconf
- Userconf
ocsigenserver.http
- Ocsigen_charset_mime
- Ocsigen_header
ocsigenserver.polytables
- Polytables

Legend:
Library
Module
Module type
Parameter
Class
Class type

Persistent data on hard disk.

There are currently three implementations of this module, one using a DBM database, on the PostgreSQL database, and one using SQLITE. Link the one your want with your program.

Persistent references

When launching the program, if the value exists on hard disk, it is loaded, otherwise it is initialised to the default value

type 'a t

Type of persistent data

type store

Data are divided into stores. Create one store for your project, where you will save all your data.

val open_store : string -> store Lwt.t

Open a store (and create it if it does not exist)

val make_persistent : store:store -> name:string -> default:'a -> 'a t Lwt.t

make_persistent store name default find a persistent value named name in store store from database, or create it with the default value default if it does not exist.

val make_persistent_lazy : 
  store:store ->
  name:string ->
  default:(unit -> 'a) ->
  'a t Lwt.t

Same as make_persistent but the default value is evaluated only if needed

val make_persistent_lazy_lwt : 
  store:store ->
  name:string ->
  default:(unit -> 'a Lwt.t) ->
  'a t Lwt.t

Lwt version of make_persistent_lazy.

val get : 'a t -> 'a Lwt.t

get pv gives the value of pv

val set : 'a t -> 'a -> unit Lwt.t

set pv value sets a persistent value pv to value

Persistent tables

type internal

module type TABLE_CONF = sig ... end

module type COLUMN = sig ... end

module type TABLE = sig ... end

module Table
  (T : TABLE_CONF)
  (Key : COLUMN)
  (Value : COLUMN) : 
  TABLE with type key = Key.t and type value = Value.t

module Column : sig ... end

type 'value table

Type of persistent table

val table_name : 'value table -> string Lwt.t

returns the name of the table

val open_table : string -> 'value table Lwt.t

Open a table (and create it if it does not exist)

val find : 'value table -> string -> 'value Lwt.t

find table key gives the value associated to key. Fails with Not_found if not found.

val add : 'value table -> string -> 'value -> unit Lwt.t

add table key value associates value to key. If the database already contains data associated with key, that data is discarded and silently replaced by the new data.

val replace_if_exists : 'value table -> string -> 'value -> unit Lwt.t

replace_if_exists table key value associates value to key only if key is already bound. If the database does not contain any data associated with key, fails with Not_found.

val remove : 'value table -> string -> unit Lwt.t

remove table key removes the entry in the table if it exists

val length : 'value table -> int Lwt.t

Size of a table.

val iter_step : (string -> 'a -> unit Lwt.t) -> 'a table -> unit Lwt.t

Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time. Nonetheless, it should not miss more than a very few data from time to time, except if the table is very old (at least 9 223 372 036 854 775 807 insertions).

val iter_table : (string -> 'a -> unit Lwt.t) -> 'a table -> unit Lwt.t

Legacy interface for iter_step

val fold_step : (string -> 'a -> 'b -> 'b Lwt.t) -> 'a table -> 'b -> 'b Lwt.t

val fold_table : (string -> 'a -> 'b -> 'b Lwt.t) -> 'a table -> 'b -> 'b Lwt.t

Legacy interface for fold_step