Ocsigen

Reference manual

Version dev

Index

Lwt
Lwt API reference
Eliom
Main modules
Pages with Ocamlduce
XHTML pages typed with variants
Other pages
Creating new kinds of pages
Ocsigen

This is a preliminary version of the documentation. Help us to improve it by filling tickets. We are looking for native english speakers to proof read the documentation. Contact us!

Previous Up 

Module Ocsigen_cache.Dlist


module Dlist: sig .. end
Doubly-linked lists with maximum size.
type 'a t 
type 'a node 
val create : int -> 'a t
val add : 'a -> 'a t -> 'a option
Adds an element to the list, and possibly returns the element that has been removed if the maximum size was exceeded.
val remove : 'a node -> unit
Removes an element from its list (if it is in a list).
val up : 'a node -> unit
Removes the element from its list without finalising, then adds it as newest.
val newest : 'a t -> 'a node option
val oldest : 'a t -> 'a node option
val size : 'a t -> int
val maxsize : 'a t -> int
val value : 'a node -> 'a
val list_of : 'a node -> 'a t option
The list to which the node belongs
val remove_n_oldest : 'a t -> int -> 'a list
remove the n oldest values (or less if the list is not long enough) ; returns the list of removed values
val set_maxsize : 'a t -> int -> 'a list
change the maximum size ; returns the list of removed values, if any.
val set_finaliser : ('a node -> unit) -> 'a t -> unit
set a function to be called automatically on a piece of data just before it disappears from the list (either by explicit removal or because the maximum size is exceeded)
val get_finaliser : 'a t -> 'a node -> unit