Index of values

abort ch abort current operations and close the channel immediately.

initializes a new client, accepts and returns it.

initializes a new client, accepts and returns it.

Used to receive handles over IPC pipes.

Check that the process has the given permissions over the named file.

Check user's permissions for a file

at_exit hook adds hook at the left of exit_hooks

atomic f transforms a sequence of io operations into one single atomic io operation.

auto_yield timeout returns a function f that will yield every timeout seconds.

Bind the pipe to a file path (Unix) or a name (Windows).

Bind the UDP handle to an IP address and port.

Bind the handle to an address and port.

blit buf1 ofs1 buf2 ofs2 len copy len bytes from buf1 starting at offset ofs1 to buf2 starting at offset ofs2.

Same as blit but the first buffer is a string instead of a byte array.

Same as blit but the second buffer is a string instead of a byte array.

block ch size f pass to f the internal buffer and an offset.

Returns the size of the internal buffer.

buffered oc returns the number of bytes in the buffer

changes the duration of a timeout.

chars_of_file name returns a stream of all characters of the file with name name.

chars_to_file name chars writes all characters of chars to name

Change the process working directory.

Changes the current working directory.

Change the process working directory.

Change the permissions of the named file.

Change the permissions of the named file.

Alters pipe permissions, allowing it to be accessed from processes run by different users.

Change the owner uid and owner gid of the named file.

Change the owner ~uid and owner ~gid of the named file.

Wrapper for Unix.chroot

Change the process root directory.

Call Uwt.Main.cleanup, if you've called Uwt.Main.run and and don't intend to call Uwt.Main.run again any time soon.

close ch closes the given channel.

Close a file descriptor.

Close a file descriptor.

Handles are closed automatically, if they are not longer referenced from the OCaml heap.

Prefer Uwt.Handle.close or Uwt.Handle.close_noerr to Uwt.Handle.close_wait.

Connect to the Unix domain socket or the named pipe.

Establish an IPv4 or IPv6 TCP connection.

copy buffer creates a copy of the given byte array.

Copies a file from ~src to ~dst.

Gets information about the CPUs on the system.

create n f defines a new timeout with n seconds duration.

Creates a new byte array of the given size.

Creates a new async handle.

Gets the current working directory

Return the default size for buffers.

detach f x runs the computation f x in a separate preemptive thread.

direct_access ch f passes to f a Uwt_io.direct_access structure.

Stops receiving this signal

Disables inheritance for file descriptors / handles that this process inherited from its parent.

drop tl n adjusts the I/O vector list tl so that it no longer includes its first n bytes.

enable_keepalive tcp delay enables keep-alive, the delay is the initial delay in seconds

Functions that are called before the main iteration.

%! does nothing here.

%! does nothing here.

error name for the given error code

Like establish_server_with_client_address, but does not pass the client address to the callback f.

establish_server_with_client_address listen_address f creates a server which listens for incoming connections on listen_address.

Executes the given command and returns its exit status.

like Sys.executable_name , but utf-8 encoded under windows and perhaps more reliable under niche operating systems

Sets of functions executed just before the program exit.

extract buffer offset length creates a new byte array of length length and copy the length bytes of buffer at offset into it.

Change the permissions of an opened file.

Change the permissions of an opened file.

Change the owner uid and owner gid of an opened file.

Change the owner ~uid and owner ~gid of the opened file.

Synchronise all data (but not metadata) of the file descriptor with the disk.

Uwt_base.Fs_functions.fdatasync is similar to Uwt_base.Fs_functions.fsync, but does not flush modified metadata unless that metadata is needed in order to allow a subsequent data retrieval to be correctly handled.

file_exists name tests if a file named name exists.

Retrieves the length of the file at the given path.

the function always succeed on Unix - but not on Windows.

files_of_directory dir returns the stream of all files of dir.

fill buffer offset length value puts value in all length bytes of buffer starting at offset offset.

flush oc performs all pending writes on oc

flush_all () flushes all open output channels

%! does nothing here.

%! does nothing here.

Return the information for the file associated with the given descriptor.

Uwt_base.Fs_functions.fstat is identical to Uwt_base.Fs_functions.stat, except that the file about which information is to be retrieved is specified by the file descriptor

Synchronise all data and metadata of the file descriptor with the disk.

synchronize a file's in-core state with storage device.

Truncates the file corresponding to the given descriptor to the given size.

truncate a file to a specified length

Uwt_base.Fs_functions.futime is identical to Uwt_base.Fs_functions.utime, except that the file about which information is to be retrieved is specified by the file descriptor

get buffer offset returns the byte at offset offset in buffer.

get_bounds () returns the minimum and the maximum number of preemptive threads.

Returns the size of the waiting queue, if no more threads are available

pw_passwd and pw_gecos will currently always contain an empty string.

Gets the size of the receive buffer that the operating system uses for the socket.

Gets the size of the send buffer that the operating system uses for the socket.

Gets memory information (in bytes).

Gets the current Window size.

getaddrinfo host service opts returns a list of Unix.addr_info records describing socket parameters and addresses suitable for communicating with the given host and service.

Asynchronous getaddrinfo(3).

Wrapper for Unix.getcwd

Return the name of the current working directory.

Return the value associated to a variable in the process environment.

Find an entry in group with the given group id.

Find an entry in group with the given group id.

Find an entry in group with the given name.

Find an entry in group with the given name.

Find an entry in hosts with the given address.

Find an entry in hosts with the given address.

Find an entry in hosts with the given name.

Find an entry in hosts with the given name.

Return the name of the local host.

Return the name of the local host.

Return the login name of the user executing the process.

Return the login name of the user executing the process.

getnameinfo addr opts returns the host name and service name corresponding to the socket address addr.

Asynchronous getnameinfo(3).

Get the name of the Unix domain socket or the named pipe to which the handle is connected.

Get the address of the peer connected to the handle.

Returns the parent process ID.

Find an entry in services with the given name.

Find an entry in protocols with the given name.

Find an entry in protocols with the given protocol number.

Find an entry in protocols with the given protocol number.

Find an entry in passwd with the given name.

Find an entry in passwd with the given name.

Find an entry in passwd with the given user id.

Find an entry in passwd with the given user id.

Gets the resource usage measures for the current process.

Find an entry in services with the given name.

Find an entry in services with the given name.

Find an entry in services with the given service number.

Find an entry in services with the given service number.

Get the name of the Unix domain socket or the named pipe.

Get the local IP and port of the UDP handle.

Get the current address to which the handle is bound.

Used to detect what type of stream should be used with a given file descriptor.

Same as Unix.handle_unix_error but catches lwt-level exceptions

Returns non-zero if the handle is referenced, zero otherwise.

hexdump oc str = hexdump_stream oc (Lwt_stream.of_string str)

hexdump_stream oc byte_stream produces the same output as the command hexdump -C.

Returns the current high-resolution real time.

init min max log initialises this module.

The only thing that can go wrong, is memory allocation.

Initialize a new TTY stream with the given file descriptor.

See comment to Uwt.Pipe.init

See comment to Uwt.Pipe.init

wrappers around uv_udp_init_ex.

wrappers around uv_tcp_init_ex.

input input mode representation

Gets address information about the network interfaces on the system.

Convert a string containing an IPv4 addresses to a binary structure.

Convert a binary structure containing an IPv4 address to a string.

Convert a string containing an IPv6 addresses to a binary structure.

Convert a binary structure containing an IPv6 address to a string.

Returns non-zero if the handle is active, zero if it's inactive.

is_busy channel returns whether the given channel is currently busy.

Return true if the given file descriptor refers to a terminal or console window, false otherwise.

Sends the specified signal to the given PID.

like chown, but do not dereference symbolic links

Functions that are called after the main iteration.

Returns the length of the channel in bytes

Returns the length of the given byte array.

lines_of_file name returns a stream of all lines of the file with name name.

lines_to_file name lines writes all lines of lines to file with name name.

link source dest creates a hard link named dest to the file named source.

Uwt_base.Fs_functions.link creates a new link (also known as a hard link) to an existing file

Start listening for incoming connections.

Gets the load average.

See the long comment at the standard Unix module

Set the current position for a file descriptor, and return the resulting offset (from the beginning of the file).

Set the current position for a file descriptor, and return the resulting offset (from the beginning of the file).

Same as Uwt_compat.Lwt_unix.stat, but in case the file is a symbolic link, return the information for the link itself.

Uwt_base.Fs_functions.lstat is identical to Uwt_base.Fs_functions.stat, except that if pathname is a symbolic link.

make ?buffer ?close ~mode perform_io is the main function for creating new channels.

Create a directory with the given permissions.

Create a directory.

The Uwt_base.Fs_functions.mkdtemp function generates a uniquely named temporary directory from template.

mode ch returns the mode of a channel

Enable TCP_NODELAY, which disables Nagle's algorithm.

Output which drops everything

Create a channel from a byte array.

of_bytes buf returns a newly allocated byte array with the same contents as buf.

of_file ?buffer ?close ~mode fd creates a channel from a file descriptor.

of_string buf returns a newly allocated byte array with the same contents as buf.

get back the original Uwt.error from an exception raised by a Uwt function

on_signal signum f calls f each time the signal with numnber signum is received by the process.

on_signal_full f is the same as on_signal f except that f also receive the signal handler identifier as argument so it can disable it.

Wait for the signal once and reset the moment the signal is received.

open_connection ?in_buffer ?out_buffer addr opens a connection to the given address and returns two channels for using it.

open_file ?buffer ?flags ?perm ~mode filename opens the file with name filename, and returns a channel for either reading or writing it.

open_temp_file () starts creating a new temporary file, and evaluates to a promise for the pair of the file's name, and an output channel for writing to the file.

This not really opens a descriptor on a directory.

Wrapper for Unix.openfile.

Equivalent to open(2).

Be careful with open* functions.

See comment to Uwt.Pipe.openpipe

See comment to Uwt.Pipe.openpipe

Uwt_base.Sys_info.os is determined at compile time (by the c compiler) and might differ from the later OS

Gets the current user's home directory.

Gets the temp directory.

output output mode representation

how many handles are waiting to be accepted with Uwt.Pipe.accept_ipc

Set the number of pending pipe instance handles when the pipe server is waiting for connections.

returns the PID of the spawned process

pipe ?cloexec ?in_buffer ?out_buffer () creates a pipe using Uwt.Unix.pipe and makes two channels from the two returned file descriptors

pipe () creates pipe using Unix.pipe and returns two file descriptors created from unix file_descriptor

pipe () creates pipes similar to Unix.pipe, but as

pipe_in () is the same as Uwt_compat.Lwt_unix.pipe but maps only the unix file descriptor for reading into a lwt one.

pipe_out () is the inverse of Uwt_compat.Lwt_unix.pipe_in.

return a plain integer number, positive or negative

position ch Returns the current position in the channel.

Uwt_base.Fs_functions.pread is equivalent to Uwt_base.Fs_functions.read, except that it reads from a given position ~fd_offset in the file without changing the file offset.

This is the same as Uwt.Debug.print_all_handles except only active handles are printed.

Prints all handles associated with the given loop to the given stream.

%! does nothing here.

%! does nothing here.

Sends the specified signal to the given process handle.

proxy buffer offset length creates a ``proxy''.

putenv ~key ~data sets the value associated to a variable in the process environment.

Uwt_base.Fs_functions.pwrite is equivalent to Uwt_base.Fs_functions.write, except that it writes into a given position ~fd_offset and does not change the file offset

Uwt_base.Fs_functions.pwritev is equivalent to Uwt_base.Fs_functions.pwrite, except that it writes into a given position and does not change the file offset

Invalid_argument, if Uwt_base.Int_result.is_error is false

read ?count ic reads at most count characters from ic.

read fd buff ofs len reads len bytes from descriptor fd, storing them in byte sequence buff, starting at position ofs in buff.

read ~pos ~len fd ~buf reads ~len bytes from descriptor fd, storing them in byte sequence buf, starting at position ~pos in ~buf.

There is currently no uv_read function in libuv, just uv_read_start and uv_read_stop.

like Uwt_base.Fs_functions.read, buf for bigarrays.

read_char ic reads the next character of ic.

Same as read_byte but does not raise End_of_file on end of input

read_chars ic returns a stream holding all characters of ic

Reads an IEEE single precision floating point value

Reads an IEEE double precision floating point value

Reads a 32-bits integer as an ocaml int

read_into ic buffer offset length reads up to length bytes, stores them in buffer at offset offset, and returns the number of bytes read.

read_into_exactly ic buffer offset length reads exactly length bytes and stores them in buffer at offset offset.

read_line ic reads one complete line from ic and returns it without the end of line.

Same as Uwt_io.read_line but do not raise End_of_file on end of input.

read_lines ic returns a stream holding all lines of ic

Read data from an incoming stream.

Stop reading data from the stream.

read_value channel reads a marshaled value from channel; it corresponds to the standard library's Marshal.from_channel.

Read the contents of a symbolic link.

Uwt_base.Fs_functions.readlink reads the value of a symbolic link

Equivalent to realpath(3) on Unix.

wrapper around realpath under Unix and GetFinalPathNameByHandleW or GetFullPathName under windows.

Wrappers around Uwt.Udp.recv_start and Uwt.Udp.recv_stop for you convenience, no callback soup.

Prepare for receiving data.

Stop listening for incoming datagrams.

Reference the given handle.

rename old new changes the name of a file from old to new.

change the name or location of a file

To be called when the program exits.

Gets the resident set size (RSS) for the current process.

Resize the internal buffer to the given size

Remove an empty directory.

Delete an empty directory

Unlike Lwt_main.run, it's not allowed to nest calls to Uwt.Main.run.

run_in_main f can be called from a detached computation to execute f () in the main preemptive thread, i.e.

On Linux, getting the type of an entry is only supported by some filesystems (btrfs, ext2, ext3 and ext4 at the time of this writing), check the getdents(2) man page.

Wakeup the event loop and call the async handle's callback.

Send data over the UDP socket.

Number of send requests currently in the queue awaiting to be processed.

Number of bytes queued for sending; strictly shows how much information is currently queued.

See comment to Uwt.Stream.write_raw

A limited equivalent to sendfile(2).

get buffer offset value changes the value of the byte at offset offset in buffer to value.

Just don't use this function.

set_bounds (min, max) set the minimum and the maximum number of preemptive threads.

Set broadcast on or off.

Change the default buffer size.

set the default handler for exception occurring after a timeout.

Sets the size of the waiting queue, if no more preemptive threads are available.

Set membership for a multicast address

Set the TTY using the specified terminal mode

Set the multicast interface to send or receive data on

Set IP multicast loop flag.

Set the multicast ttl, ttl - 1 through 255.

set_position ch pos Sets the position in the output channel.

Sets the process title.

Sets the size of the receive buffer that the operating system uses for the socket.

Sets the size of the send buffer that the operating system uses for the socket.

Set the time to live.

A command executed with the shell.

Shutdown the outgoing (write) side of a duplex stream.

Shutdown the given server

Uwt.Signal.sigwinch and Uwt.Signal.sigbreak are windows and libuv specific.

simple_init () does a simple initialization.

Enable / disable simultaneous asynchronous accept requests that are queued by the operating system when listening for new TCP connections.

sleep d is a thread that remains suspended for d seconds and then terminates.

sleep d is a thread that remains suspended for d seconds and then terminates.

sleep d is a thread that remains suspended for d milliseconds and then terminates.

Initializes the process handle and starts the process.

starts a timeout.

This will increase the reference count of the async handle.

Check the file at path for changes every interval milliseconds.

Start the handle with the given callback, which will watch the specified path for changes

Starts polling the file descriptor.

use Sys.sigterm, Sys.sigstop, etc

Timers, that are executed only once (repeat=0), are automatically closed.

Return the information for the named file.

Return the information for the named file.

The standard output for error messages, it writes data to Uwt.stderr

The standard file descriptor for printing error messages

File descriptor for standard error.

The standard input, it reads data from Uwt.stdin

The standard file descriptor for input

File descriptor for standard input.

The standard output, it writes data to Uwt.stdout

The standard file descriptor for output

File descriptor for standard output.

stops a timeout.

Decrease the reference count again

error message for the given error code

symlink source dest creates the file dest as a symbolic link to the file source.

Uwt_base.Fs_functions.symlink creates a symbolic link named ~dst which contains the string ~src

Executes the given command, waits until it terminates, and return its termination status.

timeout d is a thread that remains suspended for d seconds and then fails with Uwt_compat.Lwt_unix.Timeout.

to_bytes buf returns newly allocated bytes with the same contents as buf.

will raise Invalid_argument, if Uwt_base.Int_result.is_error is false

will raise Invalid_argument, if Uwt_base.Int_result.is_error is false

will raise Invalid_argument, if Uwt_base.Int_result.is_ok is false

to_string buf returns a newly allocated string with the same contents as buf.

map error to Unix.error , Unix.EUNKNOWNERR is used, if the mapping is not possible

Truncates the named file to the given size.

Same as Uwt.Udp.send, but won't queue a send request if it can't be completed immediately.

Write data to stream, but won't queue a write request if it can't be completed immediately.

Windows doesn't support writing multiple buffers with a single syscall for some HANDLEs (e.g.

Removes the named file.

delete a name and possibly the file it refers to

Un-reference the given handle.

Same as Uwt_bytes.blit but without bound checking.

Same as blit_string_bytes but without bound checking.

Same as blit_bytes_string but without bound checking.

Same as Uwt_bytes.fill but without bound checking.

Same as Uwt_bytes.get but without bound checking.

Same as Uwt_bytes.set but without bound checking.

Deletes the environment variable specified by name.

Update the events mask that is being watched for

Gets the current system uptime.

Uwt_base.Fs_functions.utime changes the access and modification times of a file.

utimes path atime mtime updates the access and modification times of the file at path.

libuv version used

Wrapper around RtlGetVersion.

with_connection ?fd ?in_buffer ?out_buffer addr f opens a connection to the given address and passes the channels to f

with_file ?buffer ?flags ?perm ~mode filename f opens a file and passes the channel to f.

with_pipe ?ipc f creates a new handle and passes the pipe to f.

See comments to Uwt.Pipe.with_pipe

with_temp_file f calls Uwt_io.open_temp_file (), passing all optional arguments directly to it.

with_timeout d f is a short-hand for:

write oc str writes all characters of str on oc

write fd buff ofs len writes len bytes to descriptor fd, taking them from byte sequence buff, starting at position ofs in buff.

write fd ~pos ~len fd ~buf writes ~len bytes to descriptor fd, taking them from byte sequence buf, starting at position ~pos in ~buf.

Write data to stream

Extended write function for sending handles over a pipe.

Similar to Uwt.Pipe.write2, but the send handle is a pipe.

Similar to Uwt.Pipe.write2, but the send handle is an udp socket.

write_char oc char writes char on oc

write_chars oc chars writes all characters of chars on oc

Writes an IEEE single precision floating point value

Writes an IEEE double precision floating point value

write_from oc buffer offset length writes up to length bytes to oc, from buffer at offset offset and returns the number of bytes actually written

write_from_exactly oc buffer offset length writes all length bytes from buffer at offset offset to oc

See Uwt_io.write.

See Uwt_io.write_from_exactly.

Writes an ocaml int as a 32-bits integer

write_line oc str writes str on oc followed by a new-line.

write_lines oc lines writes all lines of lines to oc

Returns the amount of queued bytes waiting to be sent

Uwt.Stream.write is eager - like the counterparts inside Lwt_unix.

See Uwt_compat.Lwt_unix.write.

write_value oc ?flags x marshals the value x to oc

write multiple buffers at once.

See comment to ! This function will fail with Unix.EOPNOTSUPP on Windows for e.g.

Similar to Uwt.Stream.writev, but if passing several buffers at once is not supported by the OS, the buffers will be written one by one.

yield () is a thread that suspends itself and then resumes as soon as possible and terminates.

yield () is a threads which suspends itself and then resumes as soon as possible and terminates.

Inputs which returns always '\x00'