Module Uwt

module Uwt: sig .. end

Basic overview:

• naming conventions mirror the conventions of libuv, so you can easily consult the official libuv manual. Selected parts of the manual are now included inside the mli files (credits to Authors), the libuv manual is however more up-to-date.

• Requests are translated to lwt-threads, therefore uv_req_t is kept internal.

• Callbacks that are called continually are most of the time not translated to the usual lwt semantic.

• Uwt is not compatible with lwt.unix. It's not a further Lwt_engine in addition to select and libev.

• Uwt is not thread safe. All uwt functions should be called from your main thread.

Please notice, that there are subtle differences compared to lwt.unix. Because all requests are accomplished by libuv (sometimes in parallel in different threads), you don't have that kind of low level control, that you have with lwt.unix. Also Lwt.cancel behaves differently and you won't notice it by looking at the type information.

• Stream.write and related functions can never be canceled. The analogous write functions in Lwt_unix however are cancelable as long as the underlying file descriptor is not opened in blocking mode. (Uwt.Stream.read currently returns the only cancelable thread inside Uwt.Stream and its subclasses. But there is no guarantee that Tcp.read will continue to be cancelable under Windows in future libuv versions.)

• Everything that is done in work threads (e.g. File I/O, DNS resolution, etc.) is cancelable, as long as the task is just queued for execution and not already running in a parallel thread. However, it's never possible to cancel a background task in Lwt_unix.

include Uwt_base

module Main: sig .. end

module Fs: sig .. end

module Handle: sig .. end

module Handle_ext: sig .. end

module Handle_fileno: sig .. end

module Stream: sig .. end

module Tcp: sig .. end

module Udp: sig .. end

module Tty: sig .. end

module Pipe: sig .. end

module Timer: sig .. end

module Signal: sig .. end

module Poll: sig .. end

module Fs_event: sig .. end

module Fs_poll: sig .. end

module Process: sig .. end

module Dns: sig .. end

module Unix: sig .. end

module C_worker: sig .. end

module Async: sig .. end

module Debug: sig .. end