package kqueue

  1. Overview
  2. Docs

Module KqueueSource

kqueue(): Kqueue is a scalable event notification interface available on macOS and various BSD systems (FreeBSD, OpenBSD, etc).

Consult the kqueue manpages to see the full list of functionality:

Sourcetype t
Sourcemodule Timeout : sig ... end
Sourcemodule Note : sig ... end
Sourcemodule Filter : sig ... end
Sourcemodule Flag : sig ... end
Sourcemodule Event_list : sig ... end
Sourceval create : unit -> t

create creates a new kernel event queue.

Sourceval kevent : t -> changelist:Event_list.t -> eventlist:Event_list.t -> Timeout.t -> int

kevent is used to register new events, and fetch any ready events from the kernel queue.

changelist is the list of new events to be submitted.

eventlist is the container where the kernel queue fill fill any new events that are ready for the user.

If eventlist is empty the kevent call will return immediately even if a non zero timeout is used. The response returns the count of new events returned by the kernel queue.

Sourceval close : t -> unit

close closes the kernel queue.

Sourcemodule Util : sig ... end
Sourceval available : bool

available Indicates if the system where this library was built has kqueue available.