package caqti

  1. Overview
  2. Docs
Unified interface to relational database libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (24)

Authors

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>
  2. N
    Nathan Rebours <nathan@cryptosense.com>
  3. B
    Basile Clément

Maintainers

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>

Sources

caqti-v2.3.0.tbz
sha256=4dadf33904c9fd25065dbf6739aa0a9eaaaea000c6981c17a534b475dd5c3891
sha512=13c1cbeff3ee0e54ed1cc8f8df5f7660c292d5d50faa9480916f3c7e578961ab3b3779395c0664346cf42509f7b98d986e8377133542869a462288d6c0e34cbf

doc/caqti.platform/Caqti_platform/Switch/Make/index.html

Module Switch.MakeSource

Parameters

module Fiber : FIBER

Signature

Sourcetype t
Sourcetype hook
Sourceexception Off

Explicit Construction and Release

The following functions are resource-unsafe, since do not scope the lifetime of constructed switches to a function call like run. They are nevertheless useful for applications which do not follow the EIO-style resource handling discipline. The caqti-eio package uses the native EIO switch implementation, which excludes these functions.

Sourceval eternal : t

A switch which is never released.

Sourceval create : unit -> t

Create a fresh releasable switch which is initially on.

Sourceval release : t -> unit Fiber.t

release sw calls all cleanup handlers on sw in reverse order of registration and marks the switch as being off.

EIO-Compatible Interface

Sourceval run : (t -> 'a Fiber.t) -> 'a Fiber.t

run f calls f with a fresh switch which will be released upon exit or in case of failure.

Sourceval check : t -> unit

check sw raises Off if sw has been turned off.

Sourceval on_release_cancellable : t -> (unit -> unit Fiber.t) -> hook

on_release_cancellable sw f registers f to be called upon the evetual release of sw unless remove_hook is called on the returned hook before that happen.

Sourceval remove_hook : hook -> unit

Given a hook returned by on_release_cancellable, remove_hook hook cancels the cleanup registered by that call.