package current

  1. Overview
  2. Docs
Pipeline language for keeping things up-to-date

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Leonard <talex5@gmail.com>
  2. A
    Antonin Décimo <antonin@tarides.com>
  3. T
    Tim McGilchrist <timmcgil@gmail.com>
  4. C
    Craig Ferguson <me@craigfe.io>
  5. E
    Etienne MARAIS <etienne@maiste.fr>
  6. A
    Anil Madhavapeddy <anil@recoil.org>
  7. David Allsopp
  8. E
    Ewan Mellor <ewan@tarides.com>
  9. K
    Kate <kit.ty.kate@disroot.org>
  10. M
    Mark Elvers <mark.elvers@tunbury.org>
  11. P
    Puneeth Chaganti <punchagan@muse-amuse.in>
  12. L
    Lucas Pluvinage <lucas@tarides.com>
  13. N
    Navin Keswani <navin@novemberkilo.com>
  14. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  15. Patrick Ferris
  16. A
    Arthur Wendling <art.wendling@gmail.com>
  17. A
    Anurag Soni <anurag@sonianurag.com>
  18. A
    Ambre Austen Suhamy <ambre@tarides.com>
  19. B
    Ben Andrew <benmandrew@gmail.com>
  20. G
    Gargi Sharma <gs051095@gmail.com>
  21. J
    Jonathan Coates <git@squiddev.cc>
  22. J
    Jules Aguillon <juloo.dsi@gmail.com>
  23. M
    Magnus Skjegstad <magnus@skjegstad.com>
  24. S
    Shon Feder <shon.feder@gmail.com>
  25. S
    smolck <46855713+smolck@users.noreply.github.com>
  26. T
    tatchi <corentin.leruth@gmail.com>

Maintainers

  1. M
    Mark Elvers <mark.elvers@tunbury.org>

Sources

ocurrent-0.7.5.tbz
md5=cd79d2a2c03fc2a548458edc92a49601
sha512=c1ee24c27b2fdc01a34a0ea041e3c5bf1fef21997dd0a12d54138c9fac2992c68b9f1dd823d8fddfc3272df793585af9f16f94ae262c149e72cd2a3ddcdf03f7

doc/current/Current/Monitor/index.html

Module Current.MonitorSource

A monitor is an input pipeline stage that can watch for external events.

Sourcetype 'a t

An 'a t is a monitor that outputs values of type 'a.

Sourceval create : read:(unit -> 'a or_error Lwt.t) -> watch:((unit -> unit) -> (unit -> unit Lwt.t) Lwt.t) -> pp:(Format.formatter -> unit) -> 'a t

create ~read ~watch ~pp is a monitor that uses read to read the current value of some external resource and watch to watch for changes. When the monitor is needed, it first calls watch refresh to start watching the resource. When this completes, it uses read () to read the current value. Whenever the watch thread calls refresh it marks the value as being out-of-date and will call read to get a new value. When the monitor is no longer required, it will call the shutdown function returned by watch to stop watching the resource. If it is needed later, it will run watch to start watching it again. This function takes care to perform only one user action (installing the watch, reading the value, or turning off the watch) at a time. For example, if refresh is called while already reading a value then it will wait for the current read to complete and then perform a second one.

Sourceval get : 'a t -> 'a Primitive.t

get t enables t and returns the primitive for it. When the primitive is released, the monitor will be disabled. Call this in your let> block.