module BatUnix:sig..end
This module only provides low-level functions and types. Unless you
know that you need low-level access to the operating system, you
probably don't. For higher-level functions, see modules BatIO,
BatFile.
Note This module is thread-safe.
Author(s): Xavier Leroy (Base module), David Teller
This module only provides low-level functions and types. Unless you
know that you need low-level access to the operating system, you
probably don't. For higher-level functions, see modules BatIO,
BatFile.
Note This module is thread-safe.
typeerror =Unix.error=
| |
E2BIG |
(* |
Argument list too long
| *) |
| |
EACCES |
(* |
Permission denied
| *) |
| |
EAGAIN |
(* |
Resource temporarily unavailable; try again
| *) |
| |
EBADF |
(* |
Bad file descriptor
| *) |
| |
EBUSY |
(* |
Resource unavailable
| *) |
| |
ECHILD |
(* |
No child process
| *) |
| |
EDEADLK |
(* |
Resource deadlock would occur
| *) |
| |
EDOM |
(* |
Domain error for math functions, etc.
| *) |
| |
EEXIST |
(* |
File exists
| *) |
| |
EFAULT |
(* |
Bad address
| *) |
| |
EFBIG |
(* |
File too large
| *) |
| |
EINTR |
(* |
Function interrupted by signal
| *) |
| |
EINVAL |
(* |
Invalid argument
| *) |
| |
EIO |
(* |
Hardware I/O error
| *) |
| |
EISDIR |
(* |
Is a directory
| *) |
| |
EMFILE |
(* |
Too many open files by the process
| *) |
| |
EMLINK |
(* |
Too many links
| *) |
| |
ENAMETOOLONG |
(* |
Filename too long
| *) |
| |
ENFILE |
(* |
Too many open files in the system
| *) |
| |
ENODEV |
(* |
No such device
| *) |
| |
ENOENT |
(* |
No such file or directory
| *) |
| |
ENOEXEC |
(* |
Not an executable file
| *) |
| |
ENOLCK |
(* |
No locks available
| *) |
| |
ENOMEM |
(* |
Not enough memory
| *) |
| |
ENOSPC |
(* |
No space left on device
| *) |
| |
ENOSYS |
(* |
Function not supported
| *) |
| |
ENOTDIR |
(* |
Not a directory
| *) |
| |
ENOTEMPTY |
(* |
Directory not empty
| *) |
| |
ENOTTY |
(* |
Inappropriate I/O control operation
| *) |
| |
ENXIO |
(* |
No such device or address
| *) |
| |
EPERM |
(* |
Operation not permitted
| *) |
| |
EPIPE |
(* |
Broken pipe
| *) |
| |
ERANGE |
(* |
Result too large
| *) |
| |
EROFS |
(* |
Read-only file system
| *) |
| |
ESPIPE |
(* |
Invalid seek e.g. on a pipe
| *) |
| |
ESRCH |
(* |
No such process
| *) |
| |
EXDEV |
(* |
Invalid link
| *) |
| |
EWOULDBLOCK |
(* |
Operation would block
| *) |
| |
EINPROGRESS |
(* |
Operation now in progress
| *) |
| |
EALREADY |
(* |
Operation already in progress
| *) |
| |
ENOTSOCK |
(* |
Socket operation on non-socket
| *) |
| |
EDESTADDRREQ |
(* |
Destination address required
| *) |
| |
EMSGSIZE |
(* |
Message too long
| *) |
| |
EPROTOTYPE |
(* |
Protocol wrong type for socket
| *) |
| |
ENOPROTOOPT |
(* |
Protocol not available
| *) |
| |
EPROTONOSUPPORT |
(* |
Protocol not supported
| *) |
| |
ESOCKTNOSUPPORT |
(* |
Socket type not supported
| *) |
| |
EOPNOTSUPP |
(* |
Operation not supported on socket
| *) |
| |
EPFNOSUPPORT |
(* |
Protocol family not supported
| *) |
| |
EAFNOSUPPORT |
(* |
Address family not supported by protocol family
| *) |
| |
EADDRINUSE |
(* |
Address already in use
| *) |
| |
EADDRNOTAVAIL |
(* |
Can't assign requested address
| *) |
| |
ENETDOWN |
(* |
Network is down
| *) |
| |
ENETUNREACH |
(* |
Network is unreachable
| *) |
| |
ENETRESET |
(* |
Network dropped connection on reset
| *) |
| |
ECONNABORTED |
(* |
Software caused connection abort
| *) |
| |
ECONNRESET |
(* |
Connection reset by peer
| *) |
| |
ENOBUFS |
(* |
No buffer space available
| *) |
| |
EISCONN |
(* |
Socket is already connected
| *) |
| |
ENOTCONN |
(* |
Socket is not connected
| *) |
| |
ESHUTDOWN |
(* |
Can't send after socket shutdown
| *) |
| |
ETOOMANYREFS |
(* |
Too many references: can't splice
| *) |
| |
ETIMEDOUT |
(* |
Connection timed out
| *) |
| |
ECONNREFUSED |
(* |
Connection refused
| *) |
| |
EHOSTDOWN |
(* |
Host is down
| *) |
| |
EHOSTUNREACH |
(* |
No route to host
| *) |
| |
ELOOP |
(* |
Too many levels of symbolic links
| *) |
| |
EOVERFLOW |
(* |
File size or position not representable
| *) |
| |
EUNKNOWNERR of |
(* |
Unknown error
| *) |
exception Unix_error of error * string * string
val error_message : error -> stringval handle_unix_error : ('a -> 'b) -> 'a -> 'bhandle_unix_error f x applies f to x and returns the result.
If the exception Unix_error is raised, it prints a message
describing the error and exits with code 2.val environment : unit -> string arrayval getenv : string -> stringNot_found if the variable is unbound.
(This function is identical to Sys.getenv.)val putenv : string -> string -> unitUnix.putenv name value sets the value associated to a
variable in the process environment.
name is the name of the environment variable,
and value its new associated value.typeprocess_status =Unix.process_status=
| |
WEXITED of |
(* |
The process terminated normally by
exit;
the argument is the return code. | *) |
| |
WSIGNALED of |
(* |
The process was killed by a signal;
the argument is the signal number.
| *) |
| |
WSTOPPED of |
(* |
The process was stopped by a signal; the argument is the
signal number.
| *) |
Sys for the
definitions of the standard signal numbers. Note that they are
not the numbers used by the OS.typewait_flag =Unix.wait_flag=
| |
WNOHANG |
(* |
do not block if no child has
died yet, but immediately return with a pid equal to 0.
| *) |
| |
WUNTRACED |
(* |
report also the children that receive stop signals.
| *) |
Unix.waitpid.val execv : string -> string array -> 'aexecv prog args execute the program in file prog, with
the arguments args, and the current process environment.
These execv* functions never return: on success, the current
program is replaced by the new one;Unix.Unix_error on failure.val execve : string -> string array -> string array -> 'aUnix.execv, except that the third argument provides the
environment to the program executed.val execvp : string -> string array -> 'aUnix.execv, except that
the program is searched in the path.val execvpe : string -> string array -> string array -> 'aUnix.execve, except that
the program is searched in the path.val fork : unit -> intval wait : unit -> int * process_statusval waitpid : wait_flag list -> int -> int * process_statusUnix.wait, but waits for the child process whose pid is given.
A pid of -1 means wait for any child.
A pid of 0 means wait for any child in the same process group
as the current process.
Negative pid arguments represent process groups.
The list of options indicates whether waitpid should return
immediately without waiting, or also report stopped children.val system : string -> process_status/bin/sh and therefore can contain redirections, quotes, variables,
etc. The result WEXITED 127 indicates that the shell couldn't
be executed.val run_and_read : string -> process_status * string(stat, output) = run_and_read cmd run the command cmd
(via Unix.system) then return its exit status stat and
output string output as read from its standard output (which
was redirected to a temporary file).val getpid : unit -> intval getppid : unit -> intval nice : int -> inttypefile_descr =Unix.file_descr
val stdin : file_descrval stdout : file_descrval stderr : file_descrtypeopen_flag =Unix.open_flag=
| |
O_RDONLY |
(* |
Open for reading
| *) |
| |
O_WRONLY |
(* |
Open for writing
| *) |
| |
O_RDWR |
(* |
Open for reading and writing
| *) |
| |
O_NONBLOCK |
(* |
Open in non-blocking mode
| *) |
| |
O_APPEND |
(* |
Open for append
| *) |
| |
O_CREAT |
(* |
Create if nonexistent
| *) |
| |
O_TRUNC |
(* |
Truncate to 0 length if existing
| *) |
| |
O_EXCL |
(* |
Fail if existing
| *) |
| |
O_NOCTTY |
(* |
Don't make this dev a controlling tty
| *) |
| |
O_DSYNC |
(* |
Writes complete as `Synchronised I/O data
integrity completion'
| *) |
| |
O_SYNC |
(* |
Writes complete as `Synchronised I/O file
integrity completion'
| *) |
| |
O_RSYNC |
(* |
Reads complete as writes (depending on
O_SYNC/O_DSYNC)
| *) |
| |
O_SHARE_DELETE |
(* |
OCaml 4 and Windows only: allow the file to be deleted
while still open
| *) |
| |
O_CLOEXEC |
(* |
Set the close-on-exec flag on the
descriptor returned by
BatUnix.openfile
Since OCaml 4.1 | *) |
Unix.openfile.typefile_perm =int
0o640 is read and write for user,
read for group, none for othersval openfile : string -> open_flag list -> file_perm -> file_descrval close : file_descr -> unitval read : file_descr -> Bytes.t -> int -> int -> intread fd buff ofs len reads len characters from descriptor
fd, storing them in string buff, starting at position ofs
in string buff. Return the number of characters actually read.val write : file_descr -> Bytes.t -> int -> int -> intwrite fd buff ofs len writes len characters to descriptor
fd, taking them from string buff, starting at position ofs
in string buff. Return the number of characters actually
written. write repeats the writing operation until all characters
have been written or an error occurs.val single_write : file_descr -> Bytes.t -> int -> int -> intwrite, but attempts to write only once.
Thus, if an error occurs, single_write guarantees that no data
has been written.val write_substring : file_descr -> string -> int -> int -> intwrite, but take the data from a string instead of a byte
sequence.val single_write_substring : file_descr -> string -> int -> int -> intsingle_write, but take the data from a string instead of
a byte sequence.val in_channel_of_descr : file_descr -> BatInnerIO.inputset_binary_mode_in ic false if text mode is desired.val out_channel_of_descr : file_descr -> unit BatInnerIO.outputset_binary_mode_out oc false if text mode is desired.val descr_of_in_channel : BatInnerIO.input -> file_descrval descr_of_out_channel : unit BatInnerIO.output -> file_descrval input_of_descr : ?autoclose:bool -> ?cleanup:bool -> file_descr -> BatInnerIO.inputinput reading from the given descriptor.
The input is initially in binary mode; use
set_binary_mode_in ic false if text mode is desired.autoclose : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
BatIO. Barring very specific needs (e.g. using file descriptors as
locks), you probably want autoclose to be true.cleanup : If true, close the underlying file descriptor
when the input is closed. If false or unspecified,
do nothing, in which case you will need to close the underlying
file descriptor yourself to ensure proper cleanup.val output_of_descr : ?cleanup:bool -> file_descr -> unit BatInnerIO.outputoutput writing on the given descriptor.
The output is initially in binary mode; use
set_binary_mode_out oc false if text mode is desired.cleanup : If true, close the underlying file descriptor
when the output is closed. If false or unspecified,
do nothing, in which case you will need to close the underlying
file descriptor yourself to ensure proper cleanup.val descr_of_input : BatInnerIO.input -> file_descr
Not all inputs have file descriptors. This function works
only for inputs which have been created using module Unix.
Raises Invalid_argument if this input
channel doesn't have a file descriptor
val descr_of_output : unit BatInnerIO.output -> file_descr
Not all inputs have file descriptors. This function works
only for inputs which have been created from module Unix.
Raises Invalid_argument if this input
channel doesn't have a file descriptor
typeseek_command =Unix.seek_command=
| |
SEEK_SET |
(* |
indicates positions relative to the beginning of the file
| *) |
| |
SEEK_CUR |
(* |
indicates positions relative to the current position
| *) |
| |
SEEK_END |
(* |
indicates positions relative to the end of the file
| *) |
Unix.lseek.val lseek : file_descr -> int -> seek_command -> intval truncate : string -> int -> unitval ftruncate : file_descr -> int -> unittypefile_kind =Unix.file_kind=
| |
S_REG |
(* |
Regular file
| *) |
| |
S_DIR |
(* |
Directory
| *) |
| |
S_CHR |
(* |
Character device
| *) |
| |
S_BLK |
(* |
Block device
| *) |
| |
S_LNK |
(* |
Symbolic link
| *) |
| |
S_FIFO |
(* |
Named pipe
| *) |
| |
S_SOCK |
(* |
Socket
| *) |
typestats =Unix.stats= {
|
st_dev : |
(* |
Device number
| *) |
|
st_ino : |
(* |
Inode number
| *) |
|
st_kind : |
(* |
Kind of the file
| *) |
|
st_perm : |
(* |
Access rights
| *) |
|
st_nlink : |
(* |
Number of links
| *) |
|
st_uid : |
(* |
User id of the owner
| *) |
|
st_gid : |
(* |
Group ID of the file's group
| *) |
|
st_rdev : |
(* |
Device minor number
| *) |
|
st_size : |
(* |
Size in bytes
| *) |
|
st_atime : |
(* |
Last access time
| *) |
|
st_mtime : |
(* |
Last modification time
| *) |
|
st_ctime : |
(* |
Last status change time
| *) |
Unix.stat calls.val stat : string -> statsval lstat : string -> statsUnix.stat, but in case the file is a symbolic link,
return the information for the link itself.val fstat : file_descr -> statsval isatty : file_descr -> booltrue if the given file descriptor refers to a terminal or
console window, false otherwise.module LargeFile:sig..end
val unlink : string -> unitval rename : string -> string -> unitrename old new changes the name of a file from old to new.val link : string -> string -> unitlink source dest creates a hard link named dest to the file
named source.typeaccess_permission =Unix.access_permission=
| |
R_OK |
(* |
Read permission
| *) |
| |
W_OK |
(* |
Write permission
| *) |
| |
X_OK |
(* |
Execution permission
| *) |
| |
F_OK |
(* |
File exists
| *) |
Unix.access call.val chmod : string -> file_perm -> unitval fchmod : file_descr -> file_perm -> unitval chown : string -> int -> int -> unitval fchown : file_descr -> int -> int -> unitval umask : int -> intval access : string -> access_permission list -> unitUnix_error otherwise.val dup : file_descr -> file_descrval dup2 : file_descr -> file_descr -> unitdup2 fd1 fd2 duplicates fd1 to fd2, closing fd2 if already
opened.val set_nonblock : file_descr -> unitval clear_nonblock : file_descr -> unitUnix.set_nonblock.val set_close_on_exec : file_descr -> unitexec functions.val clear_close_on_exec : file_descr -> unitUnix.set_close_on_exec.val mkdir : string -> file_perm -> unitval rmdir : string -> unitval chdir : string -> unitval getcwd : unit -> stringval chroot : string -> unittypedir_handle =Unix.dir_handle
val opendir : string -> dir_handleval readdir : dir_handle -> stringEnd_of_file when the end of the directory has been reached.val rewinddir : dir_handle -> unitval closedir : dir_handle -> unitval pipe : unit -> file_descr * file_descrval mkfifo : string -> file_perm -> unitval open_process_in : ?autoclose:bool -> ?cleanup:bool -> string -> BatInnerIO.input/bin/sh (cf. system).autoclose : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
BatIO. Barring very specific needs (e.g. using file descriptors as
locks), you probably want autoclose to be true.cleanup : If true or unspecified, close the process when the input
is closed. If false, do nothing, in which case you
will need to close the process yourself to ensure proper cleanup.val open_process_out : ?cleanup:bool -> string -> unit BatInnerIO.outputUnix.open_process_in, but redirect the standard input of
the command to a pipe. Data written to the returned output
is sent to the standard input of the command.
Warning writes on outputs are buffered, hence be careful
to call Pervasives.flush at the right times to ensure
correct synchronization.
cleanup : If true or unspecified, close the process when the output
is closed. If false, do nothing, in which case you
will need to close the process yourself to ensure proper cleanup.val open_process : ?autoclose:bool ->
?cleanup:bool -> string -> BatInnerIO.input * unit BatInnerIO.outputUnix.open_process_out, but redirects both the
standard input and standard output of the command to pipes
connected to the two returned input/output.
The returned input is connected to the output of the
command, and the returned output to the input of the
command.autoclose : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
BatIO. Barring very specific needs (e.g. using file descriptors as
locks), you probably want autoclose to be true.cleanup : If true or unspecified, close the process when either the
output or the output is closed. If false,
do nothing, in which case you will need to close
the process yourself to ensure proper cleanup.val open_process_full : ?autoclose:bool ->
?cleanup:bool ->
string ->
string array -> BatInnerIO.input * unit BatInnerIO.output * BatInnerIO.inputUnix.open_process, but the second argument
specifies the environment passed to the command. The result is
a triple of input/output connected respectively
to the standard output, standard input, and standard error of
the command.autoclose : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
BatIO. Barring very specific needs (e.g. using file descriptors as
locks), you probably want autoclose to be true.cleanup : If true or unspecified, close the process when either the
output or the output is closed. If false,
do nothing, in which case you will need to close
the process yourself to ensure proper cleanup.val close_process_in : BatInnerIO.input -> process_statusinput opened by Unix.open_process_in,
wait for the associated command to terminate,
and return its termination status.Unix_error(EBADF, "close_process_in", "") if the argument
is not an input opened by Unix.open_process_in.val close_process_out : unit BatInnerIO.output -> process_statusoutput opened by Unix.open_process_out,
wait for the associated command to terminate,
and return its termination status.Unix_error(EBADF, "close_process_out", "") if the argument
is not an output opened by Unix.open_process_out.val close_process : BatInnerIO.input * unit BatInnerIO.output -> process_statusinput/output opened by Unix.open_process,
wait for the associated command to terminate,
and return its termination status.Unix_error(EBADF, "close_process", "") if the argument
is not pair of input/output opened by Unix.open_process.val close_process_full : BatInnerIO.input * unit BatInnerIO.output * BatInnerIO.input ->
process_statusUnix.open_process_full,
wait for the associated command to terminate,
and return its termination status.Unix_error(EBADF, "close_process_full", "") if the argument
is not a triple of input/output opened by Unix.open_process_full.val create_process : string ->
string array ->
file_descr -> file_descr -> file_descr -> intcreate_process prog args new_stdin new_stdout new_stderr
forks a new process that executes the program
in file prog, with arguments args. The pid of the new
process is returned immediately; the new process executes
concurrently with the current process.
The standard input and outputs of the new process are connected
to the descriptors new_stdin, new_stdout and new_stderr.
Passing e.g. stdout for new_stdout prevents the redirection
and causes the new process to have the same standard output
as the current process.
The executable file prog is searched in the path.
The new process has the same environment as the current process.val create_process_env : string ->
string array ->
string array ->
file_descr -> file_descr -> file_descr -> intcreate_process_env prog args env new_stdin new_stdout new_stderr
works as Unix.create_process, except that the extra argument
env specifies the environment passed to the program.val symlink : ?to_dir:bool -> string -> string -> unit
symlink ?to_dir source dest creates the file dest as
a symbolic link to the file source. On Windows, ~to_dir
indicates if the symbolic link points to a directory or a file;
if omitted, symlink examines source using stat and picks
appropriately, if source does not exist then false is
assumed (for this reason, it is recommended that the ~to_dir
parameter be specified in new code). On Unix, ~to_dir
ignored.
Windows symbolic links are available in Windows Vista onwards. There are some important differences between Windows symlinks and their POSIX counterparts.
Windows symbolic links come in two flavours: directory and regular, which designate whether the symbolic link points to a directory or a file. The type must be correct - a directory symlink which actually points to a file cannot be selected with chdir and a file symlink which actually points to a directory cannot be read or written (note that Cygwin's emulation layer ignores this distinction).
When symbolic links are created to existing targets, this
distinction doesn't matter and symlink will automatically
create the correct kind of symbolic link. The distinction
matters when a symbolic link is created to a non-existent
target.
The other caveat is that by default symbolic links are a privileged operation. Administrators will always need to be running elevated (or with UAC disabled) and by default normal user accounts need to be granted the SeCreateSymbolicLinkPrivilege via Local Security Policy (secpol.msc) or via Active Directory.
BatUnix.has_symlink can be used to check that a process is able to
create symbolic links.
Since 4.03 the optional argument ?to_dir was added in 4.03
val has_symlink : unit -> booltrue if the user is able to create symbolic links. On Windows,
this indicates that the user not only has the SeCreateSymbolicLinkPrivilege
but is also running elevated, if necessary. On other platforms, this is
simply indicates that the symlink system call is available.val readlink : string -> stringval select : file_descr list ->
file_descr list ->
file_descr list ->
float ->
file_descr list * file_descr list * file_descr listtypelock_command =Unix.lock_command=
| |
F_ULOCK |
(* |
Unlock a region
| *) |
| |
F_LOCK |
(* |
Lock a region for writing, and block if already locked
| *) |
| |
F_TLOCK |
(* |
Lock a region for writing, or fail if already locked
| *) |
| |
F_TEST |
(* |
Test a region for other process locks
| *) |
| |
F_RLOCK |
(* |
Lock a region for reading, and block if already locked
| *) |
| |
F_TRLOCK |
(* |
Lock a region for reading, or fail if already locked
| *) |
Unix.lockf.val lockf : file_descr -> lock_command -> int -> unitlockf fd cmd size puts a lock on a region of the file opened
as fd. The region starts at the current read/write position for
fd (as set by Unix.lseek), and extends size bytes forward if
size is positive, size bytes backwards if size is negative,
or to the end of the file if size is zero.
A write lock prevents any other
process from acquiring a read or write lock on the region.
A read lock prevents any other
process from acquiring a write lock on the region, but lets
other processes acquire read locks on it.
The F_LOCK and F_TLOCK commands attempts to put a write lock
on the specified region.
The F_RLOCK and F_TRLOCK commands attempts to put a read lock
on the specified region.
If one or several locks put by another process prevent the current process
from acquiring the lock, F_LOCK and F_RLOCK block until these locks
are removed, while F_TLOCK and F_TRLOCK fail immediately with an
exception.
The F_ULOCK removes whatever locks the current process has on
the specified region.
Finally, the F_TEST command tests whether a write lock can be
acquired on the specified region, without actually putting a lock.
It returns immediately if successful, or fails otherwise.
Sys.signal and Sys.set_signal.val kill : int -> int -> unitkill pid sig sends signal number sig to the process
with id pid.typesigprocmask_command =Unix.sigprocmask_command=
| |
SIG_SETMASK |
| |
SIG_BLOCK |
| |
SIG_UNBLOCK |
val sigprocmask : sigprocmask_command -> int list -> int listsigprocmask cmd sigs changes the set of blocked signals.
If cmd is SIG_SETMASK, blocked signals are set to those in
the list sigs.
If cmd is SIG_BLOCK, the signals in sigs are added to
the set of blocked signals.
If cmd is SIG_UNBLOCK, the signals in sigs are removed
from the set of blocked signals.
sigprocmask returns the set of previously blocked signals.val sigpending : unit -> int listval sigsuspend : int list -> unitsigsuspend sigs atomically sets the blocked signals to sigs
and waits for a non-ignored, non-blocked signal to be delivered.
On return, the blocked signals are reset to their initial value.val pause : unit -> unittypeprocess_times =Unix.process_times= {
|
tms_utime : |
(* |
User time for the process
| *) |
|
tms_stime : |
(* |
System time for the process
| *) |
|
tms_cutime : |
(* |
User time for the children processes
| *) |
|
tms_cstime : |
(* |
System time for the children processes
| *) |
typetm =Unix.tm= {
|
tm_sec : |
(* |
Seconds 0..60
| *) |
|
tm_min : |
(* |
Minutes 0..59
| *) |
|
tm_hour : |
(* |
Hours 0..23
| *) |
|
tm_mday : |
(* |
Day of month 1..31
| *) |
|
tm_mon : |
(* |
Month of year 0..11
| *) |
|
tm_year : |
(* |
Year - 1900
| *) |
|
tm_wday : |
(* |
Day of week (Sunday is 0)
| *) |
|
tm_yday : |
(* |
Day of year 0..365
| *) |
|
tm_isdst : |
(* |
Daylight time savings in effect
| *) |
val time : unit -> floatval gettimeofday : unit -> floatUnix.time, but with resolution better than 1 second.val gmtime : float -> tmUnix.time, into a date and
a time. Assumes UTC (Coordinated Universal Time), also known as GMT.val localtime : float -> tmUnix.time, into a date and
a time. Assumes the local time zone.val mktime : tm -> float * tmtm argument, into
a time in seconds, as returned by Unix.time. The tm_isdst,
tm_wday and tm_yday fields of tm are ignored. Also return a
normalized copy of the given tm record, with the tm_wday,
tm_yday, and tm_isdst fields recomputed from the other fields,
and the other fields normalized (so that, e.g., 40 October is
changed into 9 November). The tm argument is interpreted in the
local time zone.val alarm : int -> intSIGALRM signal after the given number of seconds.val sleep : int -> unitval sleepf : float -> unitsleep,
but fractions of seconds are supported.val times : unit -> process_timesval utimes : string -> float -> float -> unit0.0 is interpreted as the
current time.typeinterval_timer =Unix.interval_timer=
| |
ITIMER_REAL |
(* |
decrements in real time, and sends the signal
SIGALRM when
expired. | *) |
| |
ITIMER_VIRTUAL |
(* |
decrements in process virtual time, and sends
SIGVTALRM
when expired. | *) |
| |
ITIMER_PROF |
(* |
(for profiling) decrements both when the process
is running and when the system is running on behalf of the
process; it sends
SIGPROF when expired. | *) |
typeinterval_timer_status =Unix.interval_timer_status= {
|
it_interval : |
(* |
Period
| *) |
|
it_value : |
(* |
Current value of the timer
| *) |
val getitimer : interval_timer -> interval_timer_statusval setitimer : interval_timer ->
interval_timer_status -> interval_timer_statussetitimer t s sets the interval timer t and returns
its previous status. The s argument is interpreted as follows:
s.it_value, if nonzero, is the time to the next timer expiration;
s.it_interval, if nonzero, specifies a value to
be used in reloading it_value when the timer expires.
Setting s.it_value to zero disable the timer.
Setting s.it_interval to zero causes the timer to be disabled
after its next expiration.val getuid : unit -> intval geteuid : unit -> intval setuid : int -> unitval getgid : unit -> intval getegid : unit -> intval setgid : int -> unitval getgroups : unit -> int arrayval setgroups : int array -> unitsetgroups groups sets the supplementary group IDs for the
calling process. Appropriate privileges are required.val initgroups : string -> int -> unitinitgroups user group initializes the group access list by
reading the group database /etc/group and using all groups of
which user is a member. The additional group group is also
added to the list.typepasswd_entry =Unix.passwd_entry= {
|
pw_name : |
|
pw_passwd : |
|
pw_uid : |
|
pw_gid : |
|
pw_gecos : |
|
pw_dir : |
|
pw_shell : |
passwd database.typegroup_entry =Unix.group_entry= {
|
gr_name : |
|
gr_passwd : |
|
gr_gid : |
|
gr_mem : |
groups database.val getlogin : unit -> stringval getpwnam : string -> passwd_entrypasswd with the given name.Not_found if no such entry can be found.val getgrnam : string -> group_entrygroup with the given name.Not_found if no such entry can be found.val getpwuid : int -> passwd_entrypasswd with the given user id.Not_found if no such entry can be found.val getgrgid : int -> group_entrygroup with the given group id.Not_found if no such entry can be found.typeinet_addr =Unix.inet_addr
val inet_addr_of_string : string -> inet_addrXXX.YYY.ZZZ.TTT)
for IPv4 addresses, and up to 8 numbers separated by colons
for IPv6 addresses.Failure when given a string that
does not match these formats.val string_of_inet_addr : inet_addr -> stringUnix.inet_addr_of_string for a description of the
printable representation.val inet_addr_any : inet_addrbind, representing
all the Internet addresses that the host machine possesses.val inet_addr_loopback : inet_addr127.0.0.1).val inet6_addr_any : inet_addrbind, representing
all the Internet addresses that the host machine possesses.val inet6_addr_loopback : inet_addr::1).typesocket_domain =Unix.socket_domain=
| |
PF_UNIX |
(* |
Unix domain
| *) |
| |
PF_INET |
(* |
Internet domain (IPv4)
| *) |
| |
PF_INET6 |
(* |
Internet domain (IPv6)
| *) |
PF_INET6).typesocket_type =Unix.socket_type=
| |
SOCK_STREAM |
(* |
Stream socket
| *) |
| |
SOCK_DGRAM |
(* |
Datagram socket
| *) |
| |
SOCK_RAW |
(* |
Raw socket
| *) |
| |
SOCK_SEQPACKET |
(* |
Sequenced packets socket
| *) |
typesockaddr =Unix.sockaddr=
| |
ADDR_UNIX of |
|||
| |
ADDR_INET of |
(* |
The type of socket addresses.
ADDR_UNIX name is a socket
address in the Unix domain; name is a file name in the file
system. ADDR_INET(addr,port) is a socket address in the Internet
domain; addr is the Internet address of the machine, and
port is the port number. | *) |
val socket : socket_domain -> socket_type -> int -> file_descrval domain_of_sockaddr : sockaddr -> socket_domainval socketpair : socket_domain ->
socket_type -> int -> file_descr * file_descrval accept : file_descr -> file_descr * sockaddrval bind : file_descr -> sockaddr -> unitval connect : file_descr -> sockaddr -> unitval listen : file_descr -> int -> unittypeshutdown_command =Unix.shutdown_command=
| |
SHUTDOWN_RECEIVE |
(* |
Close for receiving
| *) |
| |
SHUTDOWN_SEND |
(* |
Close for sending
| *) |
| |
SHUTDOWN_ALL |
(* |
Close both
| *) |
shutdown.val shutdown : file_descr -> shutdown_command -> unitSHUTDOWN_SEND as second argument
causes reads on the other end of the connection to return
an end-of-file condition.
SHUTDOWN_RECEIVE causes writes on the other end of the connection
to return a closed pipe condition (SIGPIPE signal).val getsockname : file_descr -> sockaddrval getpeername : file_descr -> sockaddrtypemsg_flag =Unix.msg_flag=
| |
MSG_OOB |
|||
| |
MSG_DONTROUTE |
|||
| |
MSG_PEEK |
(* |
The flags for
Unix.recv, Unix.recvfrom,
Unix.send and Unix.sendto. | *) |
val recv : file_descr -> Bytes.t -> int -> int -> msg_flag list -> intval recvfrom : file_descr ->
Bytes.t -> int -> int -> msg_flag list -> int * sockaddrval send : file_descr -> Bytes.t -> int -> int -> msg_flag list -> intval send_substring : file_descr -> string -> int -> int -> msg_flag list -> intsend, but take the data from a string instead of a byte
sequence.val sendto : file_descr ->
Bytes.t -> int -> int -> msg_flag list -> sockaddr -> intval sendto_substring : file_descr ->
string -> int -> int -> msg_flag list -> sockaddr -> intsendto, but take the data from a string instead of a
byte sequence.typesocket_bool_option =Unix.socket_bool_option=
| |
SO_DEBUG |
(* |
Record debugging information
| *) |
| |
SO_BROADCAST |
(* |
Permit sending of broadcast messages
| *) |
| |
SO_REUSEADDR |
(* |
Allow reuse of local addresses for bind
| *) |
| |
SO_KEEPALIVE |
(* |
Keep connection active
| *) |
| |
SO_DONTROUTE |
(* |
Bypass the standard routing algorithms
| *) |
| |
SO_OOBINLINE |
(* |
Leave out-of-band data in line
| *) |
| |
SO_ACCEPTCONN |
(* |
Report whether socket listening is enabled
| *) |
| |
TCP_NODELAY |
(* |
Control the Nagle algorithm for TCP sockets
| *) |
| |
IPV6_ONLY |
(* |
Forbid binding an IPv6 socket to an IPv4 address
| *) |
Unix.getsockopt
and modified with Unix.setsockopt. These options have a boolean
(true/false) value.typesocket_int_option =Unix.socket_int_option=
| |
SO_SNDBUF |
(* |
Size of send buffer
| *) |
| |
SO_RCVBUF |
(* |
Size of received buffer
| *) |
| |
SO_ERROR |
(* |
Deprecated. Use
Unix.getsockopt_error instead. | *) |
| |
SO_TYPE |
(* |
Report the socket type
| *) |
| |
SO_RCVLOWAT |
(* |
Minimum number of bytes to process for input operations
| *) |
| |
SO_SNDLOWAT |
(* |
Minimum number of bytes to process for output
operations
| *) |
Unix.getsockopt_int
and modified with Unix.setsockopt_int. These options have an
integer value.typesocket_optint_option =Unix.socket_optint_option=
| |
SO_LINGER |
(* |
Whether to linger on closed connections
that have data present, and for how long
(in seconds)
| *) |
Unix.getsockopt_optint
and modified with Unix.setsockopt_optint. These options have a
value of type int option, with None meaning ``disabled''.typesocket_float_option =Unix.socket_float_option=
| |
SO_RCVTIMEO |
(* |
Timeout for input operations
| *) |
| |
SO_SNDTIMEO |
(* |
Timeout for output operations
| *) |
Unix.getsockopt_float
and modified with Unix.setsockopt_float. These options have a
floating-point value representing a time in seconds.
The value 0 means infinite timeout.val getsockopt : file_descr -> socket_bool_option -> boolval setsockopt : file_descr -> socket_bool_option -> bool -> unitval getsockopt_int : file_descr -> socket_int_option -> intUnix.getsockopt for an integer-valued socket option.val setsockopt_int : file_descr -> socket_int_option -> int -> unitUnix.setsockopt for an integer-valued socket option.val getsockopt_optint : file_descr -> socket_optint_option -> int optionUnix.getsockopt for a socket option whose value is an
int option.val setsockopt_optint : file_descr -> socket_optint_option -> int option -> unitUnix.setsockopt for a socket option whose value is an
int option.val getsockopt_float : file_descr -> socket_float_option -> floatUnix.getsockopt for a socket option whose value is a
floating-point number.val setsockopt_float : file_descr -> socket_float_option -> float -> unitUnix.setsockopt for a socket option whose value is a
floating-point number.val getsockopt_error : file_descr -> error optionval open_connection : ?autoclose:bool ->
sockaddr -> BatInnerIO.input * unit BatInnerIO.output
Remember to call Pervasives.flush on the output at the right
times to ensure correct synchronization.
autoclose : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
BatIO. Barring very specific needs (e.g. using file descriptors as
locks), you probably want autoclose to be true.val shutdown_connection : BatInnerIO.input -> unitBatIO.close_in for closing connections.Unix.open_connection;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.val establish_server : ?autoclose:bool ->
?cleanup:bool ->
(BatInnerIO.input -> unit BatInnerIO.output -> unit) ->
sockaddr -> unit
establish_server f addr establishes a server on address
addr. For each connection on this address, function f is
called with two buffered channels connected to the client. A new
process is created for each connection. The function
Unix.establish_server never returns normally.
autoclose : If true (default value), inputs passed to f
close the input automatically once there is no more content to
read. Otherwise, the input will be closed according to the usual
rules of module BatIO. Barring very specific needs (e.g. using
file descriptors as locks), you probably want autoclose to be
true.cleanup : If true or unspecified, close the connection when
the input or the output is closed or
garbage-collected. If false, do nothing, in which case you will
need to shutdown the connection using BatUnix.shutdown_connection to
ensure proper cleanup.typehost_entry =Unix.host_entry= {
|
h_name : |
|
h_aliases : |
|
h_addrtype : |
|
h_addr_list : |
hosts database.typeprotocol_entry =Unix.protocol_entry= {
|
p_name : |
|
p_aliases : |
|
p_proto : |
protocols database.typeservice_entry =Unix.service_entry= {
|
s_name : |
|
s_aliases : |
|
s_port : |
|
s_proto : |
services database.val gethostname : unit -> stringval gethostbyname : string -> host_entryhosts with the given name.Not_found if no such entry can be found.val gethostbyaddr : inet_addr -> host_entryhosts with the given address.Not_found if no such entry can be found.val getprotobyname : string -> protocol_entryprotocols with the given nameNot_found if no such entry can be found.val getprotobynumber : int -> protocol_entryprotocols with the given protocol number.Not_found if no such entry can be found.val getservbyname : string -> string -> service_entryservices with the given name.Not_found if no such entry can be found.val getservbyport : int -> string -> service_entryservices with the given service number.Not_found if no such entry can be found.typeaddr_info =Unix.addr_info= {
|
ai_family : |
(* |
Socket domain
| *) |
|
ai_socktype : |
(* |
Socket type
| *) |
|
ai_protocol : |
(* |
Socket protocol number
| *) |
|
ai_addr : |
(* |
Address
| *) |
|
ai_canonname : |
(* |
Canonical host name
| *) |
Unix.getaddrinfo.typegetaddrinfo_option =Unix.getaddrinfo_option=
| |
AI_FAMILY of |
(* |
Impose the given socket domain
| *) |
| |
AI_SOCKTYPE of |
(* |
Impose the given socket type
| *) |
| |
AI_PROTOCOL of |
(* |
Impose the given protocol
| *) |
| |
AI_NUMERICHOST |
(* |
Do not call name resolver,
expect numeric IP address
| *) |
| |
AI_CANONNAME |
(* |
Fill the
ai_canonname field
of the result | *) |
| |
AI_PASSIVE |
(* |
Set address to ``any'' address
for use with
Unix.bind | *) |
Unix.getaddrinfo.val getaddrinfo : string -> string -> getaddrinfo_option list -> addr_info listgetaddrinfo 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. The empty list is
returned if the host or service names are unknown, or the constraints
expressed in opts cannot be satisfied.
host is either a host name or the string representation of an IP
address. host can be given as the empty string; in this case,
the ``any'' address or the ``loopback'' address are used,
depending whether opts contains AI_PASSIVE.
service is either a service name or the string representation of
a port number. service can be given as the empty string;
in this case, the port field of the returned addresses is set to 0.
opts is a possibly empty list of options that allows the caller
to force a particular socket domain (e.g. IPv6 only or IPv4 only)
or a particular socket type (e.g. TCP only or UDP only).
typename_info =Unix.name_info= {
|
ni_hostname : |
(* |
Name or IP address of host
| *) |
|
ni_service : |
Unix.getnameinfo.typegetnameinfo_option =Unix.getnameinfo_option=
| |
NI_NOFQDN |
(* |
Do not qualify local host names
| *) |
| |
NI_NUMERICHOST |
(* |
Always return host as IP address
| *) |
| |
NI_NAMEREQD |
(* |
Fail if host name cannot be determined
| *) |
| |
NI_NUMERICSERV |
(* |
Always return service as port number
| *) |
| |
NI_DGRAM |
(* |
Consider the service as UDP-based
instead of the default TCP
| *) |
Unix.getnameinfo.val getnameinfo : sockaddr -> getnameinfo_option list -> name_infogetnameinfo addr opts returns the host name and service name
corresponding to the socket address addr. opts is a possibly
empty list of options that governs how these names are obtained.Not_found if an error occurs.termios man page for a
complete description.typeterminal_io =Unix.terminal_io= {
|
mutable c_ignbrk : |
(* |
Ignore the break condition.
| *) |
|
mutable c_brkint : |
(* |
Signal interrupt on break condition.
| *) |
|
mutable c_ignpar : |
(* |
Ignore characters with parity errors.
| *) |
|
mutable c_parmrk : |
(* |
Mark parity errors.
| *) |
|
mutable c_inpck : |
(* |
Enable parity check on input.
| *) |
|
mutable c_istrip : |
(* |
Strip 8th bit on input characters.
| *) |
|
mutable c_inlcr : |
(* |
Map NL to CR on input.
| *) |
|
mutable c_igncr : |
(* |
Ignore CR on input.
| *) |
|
mutable c_icrnl : |
(* |
Map CR to NL on input.
| *) |
|
mutable c_ixon : |
(* |
Recognize XON/XOFF characters on input.
| *) |
|
mutable c_ixoff : |
(* |
Emit XON/XOFF chars to control input flow.
| *) |
|
mutable c_opost : |
(* |
Enable output processing.
| *) |
|
mutable c_obaud : |
(* |
Output baud rate (0 means close connection).
| *) |
|
mutable c_ibaud : |
(* |
Input baud rate.
| *) |
|
mutable c_csize : |
(* |
Number of bits per character (5-8).
| *) |
|
mutable c_cstopb : |
(* |
Number of stop bits (1-2).
| *) |
|
mutable c_cread : |
(* |
Reception is enabled.
| *) |
|
mutable c_parenb : |
(* |
Enable parity generation and detection.
| *) |
|
mutable c_parodd : |
(* |
Specify odd parity instead of even.
| *) |
|
mutable c_hupcl : |
(* |
Hang up on last close.
| *) |
|
mutable c_clocal : |
(* |
Ignore modem status lines.
| *) |
|
mutable c_isig : |
(* |
Generate signal on INTR, QUIT, SUSP.
| *) |
|
mutable c_icanon : |
(* |
Enable canonical processing
(line buffering and editing)
| *) |
|
mutable c_noflsh : |
(* |
Disable flush after INTR, QUIT, SUSP.
| *) |
|
mutable c_echo : |
(* |
Echo input characters.
| *) |
|
mutable c_echoe : |
(* |
Echo ERASE (to erase previous character).
| *) |
|
mutable c_echok : |
(* |
Echo KILL (to erase the current line).
| *) |
|
mutable c_echonl : |
(* |
Echo NL even if c_echo is not set.
| *) |
|
mutable c_vintr : |
(* |
Interrupt character (usually ctrl-C).
| *) |
|
mutable c_vquit : |
(* |
Quit character (usually ctrl-\).
| *) |
|
mutable c_verase : |
(* |
Erase character (usually DEL or ctrl-H).
| *) |
|
mutable c_vkill : |
(* |
Kill line character (usually ctrl-U).
| *) |
|
mutable c_veof : |
(* |
End-of-file character (usually ctrl-D).
| *) |
|
mutable c_veol : |
(* |
Alternate end-of-line char. (usually none).
| *) |
|
mutable c_vmin : |
(* |
Minimum number of characters to read
before the read request is satisfied.
| *) |
|
mutable c_vtime : |
(* |
Maximum read wait (in 0.1s units).
| *) |
|
mutable c_vstart : |
(* |
Start character (usually ctrl-Q).
| *) |
|
mutable c_vstop : |
(* |
Stop character (usually ctrl-S).
| *) |
val tcgetattr : file_descr -> terminal_iotypesetattr_when =Unix.setattr_when=
| |
TCSANOW |
| |
TCSADRAIN |
| |
TCSAFLUSH |
val tcsetattr : file_descr -> setattr_when -> terminal_io -> unitTCSANOW),
when all pending output has been transmitted (TCSADRAIN),
or after flushing all input that has been received but not
read (TCSAFLUSH). TCSADRAIN is recommended when changing
the output parameters; TCSAFLUSH, when changing the input
parameters.val tcsendbreak : file_descr -> int -> unitval tcdrain : file_descr -> unittypeflush_queue =Unix.flush_queue=
| |
TCIFLUSH |
| |
TCOFLUSH |
| |
TCIOFLUSH |
val tcflush : file_descr -> flush_queue -> unitTCIFLUSH flushes data received but not read,
TCOFLUSH flushes data written but not transmitted, and
TCIOFLUSH flushes both.typeflow_action =Unix.flow_action=
| |
TCOOFF |
| |
TCOON |
| |
TCIOFF |
| |
TCION |
val tcflow : file_descr -> flow_action -> unitTCOOFF suspends output, TCOON restarts output,
TCIOFF transmits a STOP character to suspend input,
and TCION transmits a START character to restart input.val setsid : unit -> intval is_directory : string -> boolis_directory filename returns true if filename refers to a directory (or symlink of a directory)val restart_on_EINTR : ('a -> 'b) -> 'a -> 'brestart_on_EINTR f x invokes f on x repetedly until the function returns
a value or raises another exception than EINTR.
Unless you are attempting to adapt Batteries Included to a new model of
concurrency, you probably won't need this.
val lock : BatConcurrent.lock Pervasives.ref
By default, this is BatConcurrent.nolock. However, if you're
using a version of Batteries compiled in threaded mode, this uses
BatMutex. If you're attempting to use Batteries with another
concurrency model, set the lock appropriately.
val in_channel_of_descr : file_descr -> BatInnerIO.input
val out_channel_of_descr : file_descr -> unit BatInnerIO.output
val descr_of_in_channel : BatInnerIO.input -> file_descr
val descr_of_out_channel : unit BatInnerIO.output -> file_descr