package uwt

You can search for identifiers within the package.

in-package search v0.2.0

package uwt

uwt
- Uwt
  - C_worker
  - Conv
  - Dns
  - Fs
  - Fs_event
  - Fs_functions
  - Fs_poll
  - Fs_types
  - Handle
  - Handle_ext
  - Handle_fileno
  - Int_result
  - Main
  - Misc
  - Pipe
  - Poll
  - Process
  - Signal
  - Stream
  - Sys_info
  - Tcp
  - Timer
  - Tty
  - Udp
  - Unix
uwt.base
- Uwt_base
  - Conv
  - Fs_functions
  - Fs_types
  - Int_result
  - Misc
  - Sys_info
- Uwt_bytes
uwt.compat
- Uwt_compat
  - Lwt_unix
    
    LargeFile
uwt.ext
- Uwt_chan
- Uwt_io
  - BE
  - LE
  - NumberIO
- Uwt_log
- Uwt_process
- Uwt_throttle
  - Make
    
    H
  - S
- Uwt_timeout
uwt.preemptive
- Uwt_preemptive
uwt.sync
- Uv_fs_sync

Legend:
Library
Module
Module type
Parameter
Class
Class type

Uwt main module

Basic overview:

naming conventions mirror the conventions of libuv, so you can easily consult the official libuv manual. Only the differences are explained here.

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.

Uwt is in beta stage. The interface is likely to change in the first official release. Feel free to open an issue an make suggestions about it :)

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. For example it's not guaranteed that in the following example only one operation is executed:

Lwt.pick [ op_timeout ; op_read ; op_write; op_xyz ]

include module type of Uwt_base
  with type error = Uwt_base.error
  with type 'a result = 'a Uwt_base.result
  with type file = Uwt_base.file
  with type sockaddr = Uwt_base.sockaddr
  with type 'a Int_result.t = 'a Uwt_base.Int_result.t
  with type Fs_types.uv_open_flag = Uwt_base.Fs_types.uv_open_flag
  with type Fs_types.file_kind = Uwt_base.Fs_types.file_kind
  with type Fs_types.symlink_mode = Uwt_base.Fs_types.symlink_mode
  with type Fs_types.access_permission = Uwt_base.Fs_types.access_permission
  with type Fs_types.stats = Uwt_base.Fs_types.stats
  with type Misc.timeval = Uwt_base.Misc.timeval
  with type Misc.rusage = Uwt_base.Misc.rusage
  with type Misc.cpu_times = Uwt_base.Misc.cpu_times
  with type Misc.cpu_info = Uwt_base.Misc.cpu_info
  with type Misc.interface_address = Uwt_base.Misc.interface_address
  with type Misc.handle_type = Uwt_base.Misc.handle_type
  with type Misc.version = Uwt_base.Misc.version

type error = Uwt_base.error =

| E2BIG
| EACCES
| EADDRINUSE
| EADDRNOTAVAIL
| EAFNOSUPPORT
| EAGAIN
| EAI_ADDRFAMILY
| EAI_AGAIN
| EAI_BADFLAGS
| EAI_BADHINTS
| EAI_CANCELED
| EAI_FAIL
| EAI_FAMILY
| EAI_MEMORY
| EAI_NODATA
| EAI_NONAME
| EAI_OVERFLOW
| EAI_PROTOCOL
| EAI_SERVICE
| EAI_SOCKTYPE
| EALREADY
| EBADF
| EBUSY
| ECANCELED
| ECHARSET
(*
Windows filenames (and similar parameters) are expected to be in utf8. ECHARSET is returned, if one parameter contains invalid unicode
*)
| ECONNABORTED
| ECONNREFUSED
| ECONNRESET
| EDESTADDRREQ
| EEXIST
| EFAULT
| EFBIG
| EHOSTUNREACH
| EINTR
| EINVAL
| EIO
| EISCONN
| EISDIR
| ELOOP
| EMFILE
| EMSGSIZE
| ENAMETOOLONG
| ENETDOWN
| ENETUNREACH
| ENFILE
| ENOBUFS
| ENODEV
| ENOENT
| ENOMEM
| ENONET
| ENOPROTOOPT
| ENOSPC
| ENOSYS
| ENOTCONN
| ENOTDIR
| ENOTEMPTY
| ENOTSOCK
| ENOTSUP
| EPERM
| EPIPE
| EPROTO
| EPROTONOSUPPORT
| EPROTOTYPE
| ERANGE
| EROFS
| ESHUTDOWN
| ESPIPE
| ESRCH
| ETIMEDOUT
| ETXTBSY
| EXDEV
| UNKNOWN
| EOF
| ENXIO
| EMLINK
| UWT_UNKNOWN
(*
Can't translate the error code. Perhaps your libuv version is too new or too old
*)
| UWT_EFATAL
(*
something happened that the author of uwt didn't expect. Probably a bug or a the api of libuv has changed in the meanwhile
*)
| UWT_EBADF
(*
you've already closed this handle/request
*)
| UWT_EINVAL
(*
one of your parameters doesn't look valid, e.g. negative integer when only positive integers are expected
*)
| UWT_ENOTACTIVE
(*
e.g. you've tried to stop a timer, that wasn't active
*)
| UWT_EBUSY
(*
e.g. reported, if you try to use Uwt.Stream.read_start, while you've already registered another callback for this event
*)
| UWT_ENOENT
(*
entry not found, Not_found message for callbacks
*)
| UWT_EUNAVAIL
(*
you've tried to call a function, that is not supported, either by your os or your libuv installation
*)

UWT_- error codes are introduced by uwt.

exception Uwt_error of error * string * string

val strerror : error -> string

error message for the given error code

val err_name : error -> string

error name for the given error code

type 'a result = 'a Uwt_base.result =

| Ok of 'a
| Error of error

The official result type will be used in the future

module Int_result : sig ... end

type file = Uwt_base.file

abstract type for a file descriptor

type sockaddr = Uwt_base.sockaddr

similar to Unix.sockaddr, but abstract

type buf =
  (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t

val stdin : file

val stdout : file

val stderr : file

module Fs_types : sig ... end

module type Fs_functions = sig ... end

module Conv : sig ... end

module Misc : sig ... end

module Sys_info : sig ... end

module Main : sig ... end

Analogue to Lwt_main

module Fs : sig ... end

module Handle : sig ... end

module Handle_ext : sig ... end

module Handle_fileno : sig ... end

module Stream : sig ... end

module Pipe : sig ... end

module Tcp : sig ... end

module Udp : sig ... end

module Tty : 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