package ocsigenserver

  1. Overview
  2. Docs
package ocsigenserver
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Ocsigen_cache.DlistSource

Doubly-linked lists with maximum number of entries, and (possibly) limited lifespan for entries.

Sourcetype 'a t
Sourcetype 'a node
Sourceval create : ?timer:float -> int -> 'a t

Create a dlist. It takes the maximum length of the list as parameter. The optional ?timer parameter sets a maximum lifetime for elements (in seconds).

Sourceval 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.

Sourceval remove : 'a node -> unit

Removes an element from its list. If it is not in a list, it does nothing. If it is in a list, it calls the finaliser, then removes the element. If the finaliser fails with an exception, the element is removed and the exception is raised again.

Sourceval up : 'a node -> unit

Removes the element from its list without finalising, then adds it as newest.

Sourceval newest : 'a t -> 'a node option
Sourceval oldest : 'a t -> 'a node option
Sourceval size : 'a t -> int
Sourceval maxsize : 'a t -> int
Sourceval value : 'a node -> 'a
Sourceval get_timer : 'a t -> float option

returns the timer of the Dlist

Sourceval list_of : 'a node -> 'a t option

The list to which the node belongs

Sourceval 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

Sourceval fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b

fold over the elements from the cache starting from the newest to the oldest

Sourceval fold_back : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b

fold over the elements from the cache starting from the oldest to the newest

Sourceval lwt_fold : ('b -> 'a -> 'b Lwt.t) -> 'b -> 'a t -> 'b Lwt.t

lwt version of fold

Sourceval lwt_fold_back : ('b -> 'a -> 'b Lwt.t) -> 'b -> 'a t -> 'b Lwt.t

lwt version of fold_back

Sourceval move : 'a node -> 'a t -> 'a option

Move a node from one dlist to another one, without finalizing. If one value is removed from the destination list (because its maximum size is reached), it is returned (after finalisation).

Sourceval set_maxsize : 'a t -> int -> 'a list

change the maximum size ; returns the list of removed values, if any.

Sourceval set_finaliser_before : ('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)

Sourceval get_finaliser_before : 'a t -> 'a node -> unit
Sourceval add_finaliser_before : ('a node -> unit) -> 'a t -> unit
Sourceval set_finaliser_after : ('a node -> unit) -> 'a t -> unit

set a function to be called automatically on a piece of data just after it disappears from the list (either by explicit removal or because the maximum size is exceeded)

Sourceval get_finaliser_after : 'a t -> 'a node -> unit
Sourceval add_finaliser_after : ('a node -> unit) -> 'a t -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct