package inotify

  1. Overview
  2. Docs
Inotify bindings for OCaml

Install 

dune-project
 Dependency

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

Authors

  1. W
    whitequark <whitequark@whitequark.org>

Maintainers

  1. W
    whitequark <whitequark@whitequark.org>

Sources

inotify-2.5.tbz
sha256=829aec332ccb46f61876b23c38059afcf7802516d3697c1aa15e1916be72114b
sha512=3dea21ae119cb9c524e9b4a2d3b324d8d46df41bda57c32b11563802646ac2be37b76f629f0c5fd8fc3635684feea8f1abaf7d4efd8b2b5c3618a5d935aa94b1

doc/inotify.lwt/Lwt_inotify/index.html

Module Lwt_inotifySource

An Lwt wrapper for Inotify module.

Note, whenever it is possible we provide two version of an operation:

  • f' - a pure non-blocking operation;
  • f - the same operation lifted into the Lwt monad.
Sourcetype t

Type of inotify descriptors.

Sourceval create : unit -> t Lwt.t

create () returns a new inotify descriptor.

Sourceval create' : unit -> t
  • since 2.5
Sourceval add_watch : t -> string -> Inotify.selector list -> Inotify.watch Lwt.t

add_watch desc path events sets up desc to watch for events occuring to path, and returns a watch descriptor.

Sourceval add_watch' : t -> string -> Inotify.selector list -> Inotify.watch
  • since 2.5
Sourceval rm_watch : t -> Inotify.watch -> unit Lwt.t

rm_watch desc watch stops desc from watching watch.

Sourceval rm_watch' : t -> Inotify.watch -> unit
  • since 2.5

read desc waits for an event to occur at desc.

Sourceval try_read : t -> Inotify.event option Lwt.t

try_read desc returns Some event if desc has queued events, or None otherwise.

Sourceval close : t -> unit Lwt.t

close desc frees desc.