module Unix: sig .. end
Note: all the functions of this module (except error_message
and
handle_unix_error
) are liable to raise the Unix_error
exception whenever the underlying system call signals an error.
type 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 int |
(* |
Unknown error
| *) |
exception Unix_error(error, string, string);
let error_message: error => string;
let handle_unix_error: ('a => 'b, 'a) => 'b;
handle_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.let environment: unit => array(string);
let getenv: string => string;
Not_found
if the variable is unbound.
(This function is identical to Sys.getenv
.)let putenv: (string, string) => unit;
Unix.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.type process_status =
| |
WEXITED of int |
(* |
The process terminated normally by
exit ;
the argument is the return code. | *) |
| |
WSIGNALED of int |
(* |
The process was killed by a signal;
the argument is the signal number.
| *) |
| |
WSTOPPED of int |
(* |
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.type 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
.let execv: (string, array(string)) => 'a;
execv 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;
on failure, a Unix.Unix_error
exception is raised.let execve: (string, array(string), array(string)) => 'a;
Unix.execv
, except that the third argument provides the
environment to the program executed.let execvp: (string, array(string)) => 'a;
Unix.execv
, except that
the program is searched in the path.let execvpe: (string, array(string), array(string)) => 'a;
Unix.execve
, except that
the program is searched in the path.let fork: unit => int;
let wait: unit => (int, process_status);
let waitpid: (list(wait_flag), int) => (int, process_status);
Unix.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, and whether it should report stopped
children.let 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.let getpid: unit => int;
let getppid: unit => int;
let nice: int => int;
type file_descr;
let stdin: file_descr;
let stdout: file_descr;
let stderr: file_descr;
type 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 |
(* |
Windows only: allow the file to be deleted
while still open
| *) |
| |
O_CLOEXEC |
(* |
Set the close-on-exec flag on the
descriptor returned by
Unix.openfile | *) |
Unix.openfile
.type file_perm = int;
0o640
is read and write for user,
read for group, none for otherslet openfile: (string, list(open_flag), file_perm) => file_descr;
Unix.umask
). Return a file descriptor on the named file.let close: file_descr => unit;
let read: (file_descr, bytes, int, int) => int;
read fd buff ofs len
reads len
bytes from descriptor fd
,
storing them in byte sequence buff
, starting at position ofs
in
buff
. Return the number of bytes actually read.let write: (file_descr, bytes, int, int) => int;
write fd buff ofs len
writes len
bytes to descriptor fd
,
taking them from byte sequence buff
, starting at position ofs
in buff
. Return the number of bytes actually written. write
repeats the writing operation until all bytes have been written or
an error occurs.let single_write: (file_descr, bytes, int, int) => int;
write
, but attempts to write only once.
Thus, if an error occurs, single_write
guarantees that no data
has been written.let write_substring: (file_descr, string, int, int) => int;
write
, but take the data from a string instead of a byte
sequence.let single_write_substring: (file_descr, string, int, int) => int;
single_write
, but take the data from a string instead of
a byte sequence.let in_channel_of_descr: file_descr => Pervasives.in_channel;
set_binary_mode_in ic false
if text mode is desired.let out_channel_of_descr: file_descr => Pervasives.out_channel;
set_binary_mode_out oc false
if text mode is desired.let descr_of_in_channel: Pervasives.in_channel => file_descr;
let descr_of_out_channel: Pervasives.out_channel => file_descr;
type 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
.let lseek: (file_descr, int, seek_command) => int;
let truncate: (string, int) => unit;
let ftruncate: (file_descr, int) => unit;
type 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
| *) |
type stats = {
|
st_dev : int; |
(* |
Device number
| *) |
|
st_ino : int; |
(* |
Inode number
| *) |
|
st_kind : file_kind; |
(* |
Kind of the file
| *) |
|
st_perm : file_perm; |
(* |
Access rights
| *) |
|
st_nlink : int; |
(* |
Number of links
| *) |
|
st_uid : int; |
(* |
User id of the owner
| *) |
|
st_gid : int; |
(* |
Group ID of the file's group
| *) |
|
st_rdev : int; |
(* |
Device minor number
| *) |
|
st_size : int; |
(* |
Size in bytes
| *) |
|
st_atime : float; |
(* |
Last access time
| *) |
|
st_mtime : float; |
(* |
Last modification time
| *) |
|
st_ctime : float; |
(* |
Last status change time
| *) |
Unix.stat
calls.let stat: string => stats;
let lstat: string => stats;
Unix.stat
, but in case the file is a symbolic link,
return the information for the link itself.let fstat: file_descr => stats;
let isatty: file_descr => bool;
true
if the given file descriptor refers to a terminal or
console window, false
otherwise.module LargeFile: sig .. end
let unlink: string => unit;
let rename: (string, string) => unit;
rename old new
changes the name of a file from old
to new
.let link: (string, string) => unit;
link source dest
creates a hard link named dest
to the file
named source
.type access_permission =
| |
R_OK |
(* |
Read permission
| *) |
| |
W_OK |
(* |
Write permission
| *) |
| |
X_OK |
(* |
Execution permission
| *) |
| |
F_OK |
(* |
File exists
| *) |
Unix.access
call.let chmod: (string, file_perm) => unit;
let fchmod: (file_descr, file_perm) => unit;
let chown: (string, int, int) => unit;
let fchown: (file_descr, int, int) => unit;
let umask: int => int;
let access: (string, list(access_permission)) => unit;
Unix_error
otherwise.let dup: file_descr => file_descr;
let dup2: (file_descr, file_descr) => unit;
dup2 fd1 fd2
duplicates fd1
to fd2
, closing fd2
if already
opened.let set_nonblock: file_descr => unit;
EAGAIN
or EWOULDBLOCK
error instead of blocking;
writing on a descriptor on which there is temporarily no room
for writing also raises EAGAIN
or EWOULDBLOCK
.let clear_nonblock: file_descr => unit;
Unix.set_nonblock
.let set_close_on_exec: file_descr => unit;
exec
functions.let clear_close_on_exec: file_descr => unit;
Unix.set_close_on_exec
.let mkdir: (string, file_perm) => unit;
Unix.umask
).let rmdir: string => unit;
let chdir: string => unit;
let getcwd: unit => string;
let chroot: string => unit;
type dir_handle;
let opendir: string => dir_handle;
let readdir: dir_handle => string;
End_of_file
when the end of the directory has been reached.let rewinddir: dir_handle => unit;
let closedir: dir_handle => unit;
let pipe: unit => (file_descr, file_descr);
let mkfifo: (string, file_perm) => unit;
Unix.umask
).let create_process:
(string, array(string), file_descr, file_descr, file_descr) => int;
create_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.let create_process_env:
(string, array(string), array(string), file_descr, file_descr, file_descr) =>
int;
create_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.let open_process_in: string => Pervasives.in_channel;
/bin/sh
(cf. system
).let open_process_out: string => Pervasives.out_channel;
Unix.open_process_in
, but redirect the standard input of
the command to a pipe. Data written to the returned output channel
is sent to the standard input of the command.
Warning: writes on output channels are buffered, hence be careful
to call Pervasives.flush
at the right times to ensure
correct synchronization.let open_process: string => (Pervasives.in_channel, Pervasives.out_channel);
Unix.open_process_out
, but redirects both the standard input
and standard output of the command to pipes connected to the two
returned channels. The input channel is connected to the output
of the command, and the output channel to the input of the command.let open_process_full:
(string, array(string)) =>
(Pervasives.in_channel, Pervasives.out_channel, Pervasives.in_channel);
Unix.open_process
, but the second argument specifies
the environment passed to the command. The result is a triple
of channels connected respectively to the standard output, standard input,
and standard error of the command.let close_process_in: Pervasives.in_channel => process_status;
Unix.open_process_in
,
wait for the associated command to terminate,
and return its termination status.let close_process_out: Pervasives.out_channel => process_status;
Unix.open_process_out
,
wait for the associated command to terminate,
and return its termination status.let close_process:
((Pervasives.in_channel, Pervasives.out_channel)) => process_status;
Unix.open_process
,
wait for the associated command to terminate,
and return its termination status.let close_process_full:
((Pervasives.in_channel, Pervasives.out_channel, Pervasives.in_channel)) =>
process_status;
Unix.open_process_full
,
wait for the associated command to terminate,
and return its termination status.let symlink: (string, string) => unit;
symlink source dest
creates the file dest
as a symbolic link
to the file source
.let readlink: string => string;
let select:
(list(file_descr), list(file_descr), list(file_descr), float) =>
(list(file_descr), list(file_descr), list(file_descr));
type 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
.let lockf: (file_descr, lock_command, int) => unit;
lockf 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
.let kill: (int, int) => unit;
kill pid sig
sends signal number sig
to the process
with id pid
. Under Windows, only the Sys.sigkill
signal
is emulated.type sigprocmask_command =
| |
SIG_SETMASK |
| |
SIG_BLOCK |
| |
SIG_UNBLOCK |
let sigprocmask: (sigprocmask_command, list(int)) => list(int);
sigprocmask 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.let sigpending: unit => list(int);
let sigsuspend: list(int) => unit;
sigsuspend 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.let pause: unit => unit;
type process_times = {
|
tms_utime : float; |
(* |
User time for the process
| *) |
|
tms_stime : float; |
(* |
System time for the process
| *) |
|
tms_cutime : float; |
(* |
User time for the children processes
| *) |
|
tms_cstime : float; |
(* |
System time for the children processes
| *) |
type tm = {
|
tm_sec : int; |
(* |
Seconds 0..60
| *) |
|
tm_min : int; |
(* |
Minutes 0..59
| *) |
|
tm_hour : int; |
(* |
Hours 0..23
| *) |
|
tm_mday : int; |
(* |
Day of month 1..31
| *) |
|
tm_mon : int; |
(* |
Month of year 0..11
| *) |
|
tm_year : int; |
(* |
Year - 1900
| *) |
|
tm_wday : int; |
(* |
Day of week (Sunday is 0)
| *) |
|
tm_yday : int; |
(* |
Day of year 0..365
| *) |
|
tm_isdst : bool; |
(* |
Daylight time savings in effect
| *) |
let time: unit => float;
let gettimeofday: unit => float;
Unix.time
, but with resolution better than 1 second.let gmtime: float => tm;
Unix.time
, into a date and
a time. Assumes UTC (Coordinated Universal Time), also known as GMT.let localtime: float => tm;
Unix.time
, into a date and
a time. Assumes the local time zone.let mktime: tm => (float, tm);
tm
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.let alarm: int => int;
SIGALRM
signal after the given number of seconds.let sleep: int => unit;
let times: unit => process_times;
let utimes: (string, float, float) => unit;
0.0
is interpreted as the
current time.type 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. | *) |
type interval_timer_status = {
|
it_interval : float; |
(* |
Period
| *) |
|
it_value : float; |
(* |
Current value of the timer
| *) |
let getitimer: interval_timer => interval_timer_status;
let setitimer:
(interval_timer, interval_timer_status) => interval_timer_status;
setitimer 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 disables the timer.
Setting s.it_interval
to zero causes the timer to be disabled
after its next expiration.let getuid: unit => int;
let geteuid: unit => int;
let setuid: int => unit;
let getgid: unit => int;
let getegid: unit => int;
let setgid: int => unit;
let getgroups: unit => array(int);
let setgroups: array(int) => unit;
setgroups groups
sets the supplementary group IDs for the
calling process. Appropriate privileges are required.let initgroups: (string, int) => unit;
initgroups 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.type passwd_entry = {
|
pw_name : string; |
|
pw_passwd : string; |
|
pw_uid : int; |
|
pw_gid : int; |
|
pw_gecos : string; |
|
pw_dir : string; |
|
pw_shell : string; |
passwd
database.type group_entry = {
|
gr_name : string; |
|
gr_passwd : string; |
|
gr_gid : int; |
|
gr_mem : string array; |
groups
database.let getlogin: unit => string;
let getpwnam: string => passwd_entry;
passwd
with the given name, or raise
Not_found
.let getgrnam: string => group_entry;
group
with the given name, or raise
Not_found
.let getpwuid: int => passwd_entry;
passwd
with the given user id, or raise
Not_found
.let getgrgid: int => group_entry;
group
with the given group id, or raise
Not_found
.type inet_addr;
let inet_addr_of_string: string => inet_addr;
XXX.YYY.ZZZ.TTT
)
for IPv4 addresses, and up to 8 numbers separated by colons
for IPv6 addresses. Raise Failure
when given a string that
does not match these formats.let string_of_inet_addr: inet_addr => string;
Unix.inet_addr_of_string
for a description of the
printable representation.let inet_addr_any: inet_addr;
bind
, representing
all the Internet addresses that the host machine possesses.let inet_addr_loopback: inet_addr;
127.0.0.1
).let inet6_addr_any: inet_addr;
bind
, representing
all the Internet addresses that the host machine possesses.let inet6_addr_loopback: inet_addr;
::1
).type socket_domain =
| |
PF_UNIX |
(* |
Unix domain
| *) |
| |
PF_INET |
(* |
Internet domain (IPv4)
| *) |
| |
PF_INET6 |
(* |
Internet domain (IPv6)
| *) |
PF_INET6
).type socket_type =
| |
SOCK_STREAM |
(* |
Stream socket
| *) |
| |
SOCK_DGRAM |
(* |
Datagram socket
| *) |
| |
SOCK_RAW |
(* |
Raw socket
| *) |
| |
SOCK_SEQPACKET |
(* |
Sequenced packets socket
| *) |
type sockaddr =
| |
ADDR_UNIX of string |
|||
| |
ADDR_INET of inet_addr * int |
(* |
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. | *) |
let socket: (socket_domain, socket_type, int) => file_descr;
let domain_of_sockaddr: sockaddr => socket_domain;
let socketpair: (socket_domain, socket_type, int) => (file_descr, file_descr);
let accept: file_descr => (file_descr, sockaddr);
let bind: (file_descr, sockaddr) => unit;
let connect: (file_descr, sockaddr) => unit;
let listen: (file_descr, int) => unit;
type shutdown_command =
| |
SHUTDOWN_RECEIVE |
(* |
Close for receiving
| *) |
| |
SHUTDOWN_SEND |
(* |
Close for sending
| *) |
| |
SHUTDOWN_ALL |
(* |
Close both
| *) |
shutdown
.let shutdown: (file_descr, shutdown_command) => unit;
SHUTDOWN_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).let getsockname: file_descr => sockaddr;
let getpeername: file_descr => sockaddr;
type msg_flag =
| |
MSG_OOB |
|||
| |
MSG_DONTROUTE |
|||
| |
MSG_PEEK |
(* | *) |
let recv: (file_descr, bytes, int, int, list(msg_flag)) => int;
let recvfrom: (file_descr, bytes, int, int, list(msg_flag)) => (int, sockaddr);
let send: (file_descr, bytes, int, int, list(msg_flag)) => int;
let send_substring: (file_descr, string, int, int, list(msg_flag)) => int;
send
, but take the data from a string instead of a byte
sequence.let sendto: (file_descr, bytes, int, int, list(msg_flag), sockaddr) => int;
let sendto_substring:
(file_descr, string, int, int, list(msg_flag), sockaddr) => int;
sendto
, but take the data from a string instead of a
byte sequence.type 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.type 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.type 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''.type 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.let getsockopt: (file_descr, socket_bool_option) => bool;
let setsockopt: (file_descr, socket_bool_option, bool) => unit;
let getsockopt_int: (file_descr, socket_int_option) => int;
Unix.getsockopt
for an integer-valued socket option.let setsockopt_int: (file_descr, socket_int_option, int) => unit;
Unix.setsockopt
for an integer-valued socket option.let getsockopt_optint: (file_descr, socket_optint_option) => option(int);
let setsockopt_optint: (file_descr, socket_optint_option, option(int)) => unit;
let getsockopt_float: (file_descr, socket_float_option) => float;
Unix.getsockopt
for a socket option whose value is a
floating-point number.let setsockopt_float: (file_descr, socket_float_option, float) => unit;
Unix.setsockopt
for a socket option whose value is a
floating-point number.let getsockopt_error: file_descr => option(error);
let open_connection:
sockaddr => (Pervasives.in_channel, Pervasives.out_channel);
Pervasives.flush
on the output channel at the right
times to ensure correct synchronization.let shutdown_connection: Pervasives.in_channel => unit;
Unix.open_connection
;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection. This does not fully close the
file descriptor associated with the channel, which you must remember
to free via Pervasives.close_in
.let establish_server:
((Pervasives.in_channel, Pervasives.out_channel) => unit, sockaddr) => unit;
Unix.establish_server
never returns normally.type host_entry = {
|
h_name : string; |
|
h_aliases : string array; |
|
h_addrtype : socket_domain; |
|
h_addr_list : inet_addr array; |
hosts
database.type protocol_entry = {
|
p_name : string; |
|
p_aliases : string array; |
|
p_proto : int; |
protocols
database.type service_entry = {
|
s_name : string; |
|
s_aliases : string array; |
|
s_port : int; |
|
s_proto : string; |
services
database.let gethostname: unit => string;
let gethostbyname: string => host_entry;
hosts
with the given name, or raise
Not_found
.let gethostbyaddr: inet_addr => host_entry;
hosts
with the given address, or raise
Not_found
.let getprotobyname: string => protocol_entry;
protocols
with the given name, or raise
Not_found
.let getprotobynumber: int => protocol_entry;
protocols
with the given protocol number,
or raise Not_found
.let getservbyname: (string, string) => service_entry;
services
with the given name, or raise
Not_found
.let getservbyport: (int, string) => service_entry;
services
with the given service number,
or raise Not_found
.type addr_info = {
|
ai_family : socket_domain; |
(* |
Socket domain
| *) |
|
ai_socktype : socket_type; |
(* |
Socket type
| *) |
|
ai_protocol : int; |
(* |
Socket protocol number
| *) |
|
ai_addr : sockaddr; |
(* |
Address
| *) |
|
ai_canonname : string; |
(* |
Canonical host name
| *) |
Unix.getaddrinfo
.type getaddrinfo_option =
| |
AI_FAMILY of socket_domain |
(* |
Impose the given socket domain
| *) |
| |
AI_SOCKTYPE of socket_type |
(* |
Impose the given socket type
| *) |
| |
AI_PROTOCOL of int |
(* |
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
.let getaddrinfo: (string, string, list(getaddrinfo_option)) => list(addr_info);
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. 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).
type name_info = {
|
ni_hostname : string; |
(* |
Name or IP address of host
| *) |
|
ni_service : string; |
Unix.getnameinfo
.type 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
.let getnameinfo: (sockaddr, list(getnameinfo_option)) => name_info;
getnameinfo 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.
Raise Not_found
if an error occurs.termios
man page for a
complete description.type terminal_io = {
|
mutable c_ignbrk : bool; |
(* |
Ignore the break condition.
| *) |
|
mutable c_brkint : bool; |
(* |
Signal interrupt on break condition.
| *) |
|
mutable c_ignpar : bool; |
(* |
Ignore characters with parity errors.
| *) |
|
mutable c_parmrk : bool; |
(* |
Mark parity errors.
| *) |
|
mutable c_inpck : bool; |
(* |
Enable parity check on input.
| *) |
|
mutable c_istrip : bool; |
(* |
Strip 8th bit on input characters.
| *) |
|
mutable c_inlcr : bool; |
(* |
Map NL to CR on input.
| *) |
|
mutable c_igncr : bool; |
(* |
Ignore CR on input.
| *) |
|
mutable c_icrnl : bool; |
(* |
Map CR to NL on input.
| *) |
|
mutable c_ixon : bool; |
(* |
Recognize XON/XOFF characters on input.
| *) |
|
mutable c_ixoff : bool; |
(* |
Emit XON/XOFF chars to control input flow.
| *) |
|
mutable c_opost : bool; |
(* |
Enable output processing.
| *) |
|
mutable c_obaud : int; |
(* |
Output baud rate (0 means close connection).
| *) |
|
mutable c_ibaud : int; |
(* |
Input baud rate.
| *) |
|
mutable c_csize : int; |
(* |
Number of bits per character (5-8).
| *) |
|
mutable c_cstopb : int; |
(* |
Number of stop bits (1-2).
| *) |
|
mutable c_cread : bool; |
(* |
Reception is enabled.
| *) |
|
mutable c_parenb : bool; |
(* |
Enable parity generation and detection.
| *) |
|
mutable c_parodd : bool; |
(* |
Specify odd parity instead of even.
| *) |
|
mutable c_hupcl : bool; |
(* |
Hang up on last close.
| *) |
|
mutable c_clocal : bool; |
(* |
Ignore modem status lines.
| *) |
|
mutable c_isig : bool; |
(* |
Generate signal on INTR, QUIT, SUSP.
| *) |
|
mutable c_icanon : bool; |
(* |
Enable canonical processing
(line buffering and editing)
| *) |
|
mutable c_noflsh : bool; |
(* |
Disable flush after INTR, QUIT, SUSP.
| *) |
|
mutable c_echo : bool; |
(* |
Echo input characters.
| *) |
|
mutable c_echoe : bool; |
(* |
Echo ERASE (to erase previous character).
| *) |
|
mutable c_echok : bool; |
(* |
Echo KILL (to erase the current line).
| *) |
|
mutable c_echonl : bool; |
(* |
Echo NL even if c_echo is not set.
| *) |
|
mutable c_vintr : char; |
(* |
Interrupt character (usually ctrl-C).
| *) |
|
mutable c_vquit : char; |
(* |
Quit character (usually ctrl-\).
| *) |
|
mutable c_verase : char; |
(* |
Erase character (usually DEL or ctrl-H).
| *) |
|
mutable c_vkill : char; |
(* |
Kill line character (usually ctrl-U).
| *) |
|
mutable c_veof : char; |
(* |
End-of-file character (usually ctrl-D).
| *) |
|
mutable c_veol : char; |
(* |
Alternate end-of-line char. (usually none).
| *) |
|
mutable c_vmin : int; |
(* |
Minimum number of characters to read
before the read request is satisfied.
| *) |
|
mutable c_vtime : int; |
(* |
Maximum read wait (in 0.1s units).
| *) |
|
mutable c_vstart : char; |
(* |
Start character (usually ctrl-Q).
| *) |
|
mutable c_vstop : char; |
(* |
Stop character (usually ctrl-S).
| *) |
let tcgetattr: file_descr => terminal_io;
type setattr_when =
| |
TCSANOW |
| |
TCSADRAIN |
| |
TCSAFLUSH |
let tcsetattr: (file_descr, setattr_when, terminal_io) => unit;
TCSANOW
),
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.let tcsendbreak: (file_descr, int) => unit;
let tcdrain: file_descr => unit;
type flush_queue =
| |
TCIFLUSH |
| |
TCOFLUSH |
| |
TCIOFLUSH |
let tcflush: (file_descr, flush_queue) => unit;
TCIFLUSH
flushes data received but not read,
TCOFLUSH
flushes data written but not transmitted, and
TCIOFLUSH
flushes both.type flow_action =
| |
TCOOFF |
| |
TCOON |
| |
TCIOFF |
| |
TCION |
let tcflow: (file_descr, flow_action) => unit;
TCOOFF
suspends output, TCOON
restarts output,
TCIOFF
transmits a STOP character to suspend input,
and TCION
transmits a START character to restart input.let setsid: unit => int;