module UnixLabels: sig .. end
Interface to the Unix system.
To use as replacement to default
Unix module,
add
module Unix = UnixLabels in your implementation.
Error report
type Unix.error =
| |
E2BIG |
| |
EACCES |
| |
EAGAIN |
| |
EBADF |
| |
EBUSY |
| |
ECHILD |
| |
EDEADLK |
| |
EDOM |
| |
EEXIST |
| |
EFAULT |
| |
EFBIG |
| |
EINTR |
| |
EINVAL |
| |
EIO |
| |
EISDIR |
| |
EMFILE |
| |
EMLINK |
| |
ENAMETOOLONG |
| |
ENFILE |
| |
ENODEV |
| |
ENOENT |
| |
ENOEXEC |
| |
ENOLCK |
| |
ENOMEM |
| |
ENOSPC |
| |
ENOSYS |
| |
ENOTDIR |
| |
ENOTEMPTY |
| |
ENOTTY |
| |
ENXIO |
| |
EPERM |
| |
EPIPE |
| |
ERANGE |
| |
EROFS |
| |
ESPIPE |
| |
ESRCH |
| |
EXDEV |
| |
EWOULDBLOCK |
| |
EINPROGRESS |
| |
EALREADY |
| |
ENOTSOCK |
| |
EDESTADDRREQ |
| |
EMSGSIZE |
| |
EPROTOTYPE |
| |
ENOPROTOOPT |
| |
EPROTONOSUPPORT |
| |
ESOCKTNOSUPPORT |
| |
EOPNOTSUPP |
| |
EPFNOSUPPORT |
| |
EAFNOSUPPORT |
| |
EADDRINUSE |
| |
EADDRNOTAVAIL |
| |
ENETDOWN |
| |
ENETUNREACH |
| |
ENETRESET |
| |
ECONNABORTED |
| |
ECONNRESET |
| |
ENOBUFS |
| |
EISCONN |
| |
ENOTCONN |
| |
ESHUTDOWN |
| |
ETOOMANYREFS |
| |
ETIMEDOUT |
| |
ECONNREFUSED |
| |
EHOSTDOWN |
| |
EHOSTUNREACH |
| |
ELOOP |
| |
EOVERFLOW |
| |
EUNKNOWNERR of int |
The type of error codes.
Errors defined in the POSIX standard
and additional errors from UNIX98 and BSD.
All other errors are mapped to EUNKNOWNERR.
exception Unix_error of error * string * string
Raised by the system calls below when an error is encountered.
The first component is the error code; the second component
is the function name; the third component is the string parameter
to the function, if it has one, or the empty string otherwise.
val error_message : error -> string
Return a string describing the given error code.
val 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.
Access to the process environment
val environment : unit -> string array
Return the process environment, as an array of strings
with the format ``variable=value''.
val getenv : string -> string
Return the value associated to a variable in the process
environment. Raise Not_found if the variable is unbound.
(This function is identical to Sys.getenv.)
val 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.
Process handling
type Unix.process_status =
| |
WEXITED of int |
| |
WSIGNALED of int |
| |
WSTOPPED of int |
The termination status of a process. See module
Sys for the
definitions of the standard signal numbers. Note that they are
not the numbers used by the OS.
type Unix.wait_flag =
val execv : prog:string -> args:string array -> '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
UnixLabels.Unix_error exception is raised.
val execve : prog:string -> args:string array -> env:string array -> 'a
Same as
UnixLabels.execv, except that the third argument provides the
environment to the program executed.
val execvp : prog:string -> args:string array -> 'a
val execvpe : prog:string -> args:string array -> env:string array -> 'a
val fork : unit -> int
Fork a new process. The returned integer is 0 for the child
process, the pid of the child process for the parent process.
val wait : unit -> int * process_status
Wait until one of the children processes die, and return its pid
and termination status.
val waitpid : mode:wait_flag list -> int -> int * process_status
Same as
UnixLabels.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
Execute the given command, wait until it terminates, and return
its termination status. The string is interpreted by the shell
/bin/sh and therefore can contain redirections, quotes, variables,
etc. The result WEXITED 127 indicates that the shell couldn't
be executed.
val getpid : unit -> int
Return the pid of the process.
val getppid : unit -> int
Return the pid of the parent process.
val nice : int -> int
Change the process priority. The integer argument is added to the
``nice'' value. (Higher values of the ``nice'' value mean
lower priorities.) Return the new nice value.
type Unix.file_descr
The abstract type of file descriptors.
val stdin : file_descr
File descriptor for standard input.
val stdout : file_descr
File descriptor for standard output.
val stderr : file_descr
File descriptor for standard error.
type Unix.open_flag =
| |
O_RDONLY |
| |
O_WRONLY |
| |
O_RDWR |
| |
O_NONBLOCK |
| |
O_APPEND |
| |
O_CREAT |
| |
O_TRUNC |
| |
O_EXCL |
| |
O_NOCTTY |
| |
O_DSYNC |
| |
O_SYNC |
| |
O_RSYNC |
| |
O_SHARE_DELETE |
| |
O_CLOEXEC |
type int
The type of file access rights, e.g. 0o640 is read and write for user,
read for group, none for others
val openfile : string ->
mode:open_flag list ->
perm:file_perm -> file_descr
Open the named file with the given flags. Third argument is
the permissions to give to the file if it is created. Return
a file descriptor on the named file.
val close : file_descr -> unit
Close a file descriptor.
val read : file_descr -> buf:string -> pos:int -> len:int -> int
read 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 -> buf:string -> pos:int -> len:int -> int
write 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 -> buf:string -> pos:int -> len:int -> int
Same as write, but attempts to write only once.
Thus, if an error occurs, single_write guarantees that no data
has been written.
val in_channel_of_descr : file_descr -> in_channel
Create an input channel reading from the given descriptor.
The channel is initially in binary mode; use
set_binary_mode_in ic false if text mode is desired.
val out_channel_of_descr : file_descr -> out_channel
Create an output channel writing on the given descriptor.
The channel is initially in binary mode; use
set_binary_mode_out oc false if text mode is desired.
val descr_of_in_channel : in_channel -> file_descr
Return the descriptor corresponding to an input channel.
val descr_of_out_channel : out_channel -> file_descr
Return the descriptor corresponding to an output channel.
Seeking and truncating
type Unix.seek_command =
| |
SEEK_SET |
| |
SEEK_CUR |
| |
SEEK_END |
val lseek : file_descr -> int -> mode:seek_command -> int
Set the current position for a file descriptor, and return the resulting
offset (from the beginning of the file).
val truncate : string -> len:int -> unit
Truncates the named file to the given size.
val ftruncate : file_descr -> len:int -> unit
Truncates the file corresponding to the given descriptor
to the given size.
File status
type Unix.file_kind =
| |
S_REG |
| |
S_DIR |
| |
S_CHR |
| |
S_BLK |
| |
S_LNK |
| |
S_FIFO |
| |
S_SOCK |
type Unix.stats = {
|
st_dev : int; |
|
st_ino : int; |
|
st_kind : file_kind; |
|
st_perm : file_perm; |
|
st_nlink : int; |
|
st_uid : int; |
|
st_gid : int; |
|
st_rdev : int; |
|
st_size : int; |
|
st_atime : float; |
|
st_mtime : float; |
|
st_ctime : float; |
}
val stat : string -> stats
Return the information for the named file.
val lstat : string -> stats
Same as
UnixLabels.stat, but in case the file is a symbolic link,
return the information for the link itself.
val fstat : file_descr -> stats
Return the information for the file associated with the given
descriptor.
val isatty : file_descr -> bool
Return true if the given file descriptor refers to a terminal or
console window, false otherwise.
File operations on large files
module LargeFile: sig .. end
File operations on large files.
Operations on file names
val unlink : string -> unit
Removes the named file
val rename : src:string -> dst:string -> unit
rename old new changes the name of a file from old to new.
val link : src:string -> dst:string -> unit
link source dest creates a hard link named dest to the file
named source.
File permissions and ownership
type Unix.access_permission =
| |
R_OK |
| |
W_OK |
| |
X_OK |
| |
F_OK |
val chmod : string -> perm:file_perm -> unit
Change the permissions of the named file.
val fchmod : file_descr -> perm:file_perm -> unit
Change the permissions of an opened file.
val chown : string -> uid:int -> gid:int -> unit
Change the owner uid and owner gid of the named file.
val fchown : file_descr -> uid:int -> gid:int -> unit
Change the owner uid and owner gid of an opened file.
val umask : int -> int
Set the process's file mode creation mask, and return the previous
mask.
val access : string -> perm:access_permission list -> unit
Check that the process has the given permissions over the named
file. Raise Unix_error otherwise.
Operations on file descriptors
val dup : file_descr -> file_descr
Return a new file descriptor referencing the same file as
the given descriptor.
val dup2 : src:file_descr -> dst:file_descr -> unit
dup2 fd1 fd2 duplicates fd1 to fd2, closing fd2 if already
opened.
val set_nonblock : file_descr -> unit
Set the ``non-blocking'' flag on the given descriptor.
When the non-blocking flag is set, reading on a descriptor
on which there is temporarily no data available raises the
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.
val clear_nonblock : file_descr -> unit
val set_close_on_exec : file_descr -> unit
Set the ``close-on-exec'' flag on the given descriptor.
A descriptor with the close-on-exec flag is automatically
closed when the current process starts another program with
one of the exec functions.
val clear_close_on_exec : file_descr -> unit
Directories
val mkdir : string -> perm:file_perm -> unit
Create a directory with the given permissions.
val rmdir : string -> unit
Remove an empty directory.
val chdir : string -> unit
Change the process working directory.
val getcwd : unit -> string
Return the name of the current working directory.
val chroot : string -> unit
Change the process root directory.
type Unix.dir_handle
The type of descriptors over opened directories.
val opendir : string -> dir_handle
Open a descriptor on a directory
val readdir : dir_handle -> string
Return the next entry in a directory.
Raises End_of_file when the end of the directory has been reached.
val rewinddir : dir_handle -> unit
Reposition the descriptor to the beginning of the directory
val closedir : dir_handle -> unit
Close a directory descriptor.
Pipes and redirections
val pipe : unit -> file_descr * file_descr
Create a pipe. The first component of the result is opened
for reading, that's the exit to the pipe. The second component is
opened for writing, that's the entrance to the pipe.
val mkfifo : string -> perm:file_perm -> unit
Create a named pipe with the given permissions.
High-level process and redirection management
val create_process : prog:string ->
args:string array ->
stdin:file_descr ->
stdout:file_descr -> stderr: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.
val create_process_env : prog:string ->
args:string array ->
env:string array ->
stdin:file_descr ->
stdout:file_descr -> stderr:file_descr -> int
create_process_env prog args env new_stdin new_stdout new_stderr
works as
UnixLabels.create_process, except that the extra argument
env specifies the environment passed to the program.
val open_process_in : string -> in_channel
High-level pipe and process management. This function
runs the given command in parallel with the program.
The standard output of the command is redirected to a pipe,
which can be read via the returned input channel.
The command is interpreted by the shell /bin/sh (cf. system).
val open_process_out : string -> out_channel
Same as
UnixLabels.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
flush at the right times to ensure
correct synchronization.
val open_process : string -> in_channel * out_channel
Same as
UnixLabels.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.
val open_process_full : string ->
env:string array ->
in_channel * out_channel * in_channel
Similar to
UnixLabels.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.
val close_process_in : in_channel -> process_status
Close channels opened by
UnixLabels.open_process_in,
wait for the associated command to terminate,
and return its termination status.
val close_process_out : out_channel -> process_status
val close_process : in_channel * out_channel -> process_status
Close channels opened by
UnixLabels.open_process,
wait for the associated command to terminate,
and return its termination status.
val close_process_full : in_channel * out_channel * in_channel ->
process_status
Symbolic links
val symlink : src:string -> dst:string -> unit
symlink source dest creates the file dest as a symbolic link
to the file source.
val readlink : string -> string
Read the contents of a link.
Polling
val select : read:file_descr list ->
write:file_descr list ->
except:file_descr list ->
timeout:float ->
file_descr list * file_descr list *
file_descr list
Wait until some input/output operations become possible on
some channels. The three list arguments are, respectively, a set
of descriptors to check for reading (first argument), for writing
(second argument), or for exceptional conditions (third argument).
The fourth argument is the maximal timeout, in seconds; a
negative fourth argument means no timeout (unbounded wait).
The result is composed of three sets of descriptors: those ready
for reading (first component), ready for writing (second component),
and over which an exceptional condition is pending (third
component).
Locking
type Unix.lock_command =
| |
F_ULOCK |
| |
F_LOCK |
| |
F_TLOCK |
| |
F_TEST |
| |
F_RLOCK |
| |
F_TRLOCK |
val lockf : file_descr -> mode:lock_command -> len: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
UnixLabels.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.
Signals
Note: installation of signal handlers is performed via
the functions
Sys.signal and
Sys.set_signal.
val kill : pid:int -> signal:int -> unit
kill pid sig sends signal number sig to the process
with id pid.
type Unix.sigprocmask_command =
| |
SIG_SETMASK |
| |
SIG_BLOCK |
| |
SIG_UNBLOCK |
val sigprocmask : mode:sigprocmask_command -> int list -> int list
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.
val sigpending : unit -> int list
Return the set of blocked signals that are currently pending.
val sigsuspend : int list -> 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.
val pause : unit -> unit
Wait until a non-ignored, non-blocked signal is delivered.
Time functions
type Unix.process_times = {
|
tms_utime : float; |
|
tms_stime : float; |
|
tms_cutime : float; |
|
tms_cstime : float; |
}
The execution times (CPU times) of a process.
type Unix.tm = {
|
tm_sec : int; |
|
tm_min : int; |
|
tm_hour : int; |
|
tm_mday : int; |
|
tm_mon : int; |
|
tm_year : int; |
|
tm_wday : int; |
|
tm_yday : int; |
|
tm_isdst : bool; |
}
The type representing wallclock time and calendar date.
val time : unit -> float
Return the current time since 00:00:00 GMT, Jan. 1, 1970,
in seconds.
val gettimeofday : unit -> float
val gmtime : float -> tm
Convert a time in seconds, as returned by
UnixLabels.time, into a date
and a time. Assumes UTC (Coordinated Universal Time), also known as GMT.
val localtime : float -> tm
Convert a time in seconds, as returned by
UnixLabels.time, into a date
and a time. Assumes the local time zone.
val mktime : tm -> float * tm
Convert a date and time, specified by the
tm argument, into
a time in seconds, as returned by
UnixLabels.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 -> int
Schedule a SIGALRM signal after the given number of seconds.
val sleep : int -> unit
Stop execution for the given number of seconds.
val times : unit -> process_times
Return the execution times of the process.
val utimes : string -> access:float -> modif:float -> unit
Set the last access time (second arg) and last modification time
(third arg) for a file. Times are expressed in seconds from
00:00:00 GMT, Jan. 1, 1970. A time of 0.0 is interpreted as the
current time.
type Unix.interval_timer =
| |
ITIMER_REAL |
| |
ITIMER_VIRTUAL |
| |
ITIMER_PROF |
The three kinds of interval timers.
type Unix.interval_timer_status = {
|
it_interval : float; |
|
it_value : float; |
}
The type describing the status of an interval timer
val getitimer : interval_timer -> interval_timer_status
Return the current status of the given interval timer.
val 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 disable the timer.
Setting s.it_interval to zero causes the timer to be disabled
after its next expiration.
User id, group id
val getuid : unit -> int
Return the user id of the user executing the process.
val geteuid : unit -> int
Return the effective user id under which the process runs.
val setuid : int -> unit
Set the real user id and effective user id for the process.
val getgid : unit -> int
Return the group id of the user executing the process.
val getegid : unit -> int
Return the effective group id under which the process runs.
val setgid : int -> unit
Set the real group id and effective group id for the process.
val getgroups : unit -> int array
Return the list of groups to which the user executing the process
belongs.
val setgroups : int array -> unit
setgroups groups sets the supplementary group IDs for the
calling process. Appropriate privileges are required.
val 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 Unix.passwd_entry = {
|
pw_name : string; |
|
pw_passwd : string; |
|
pw_uid : int; |
|
pw_gid : int; |
|
pw_gecos : string; |
|
pw_dir : string; |
|
pw_shell : string; |
}
Structure of entries in the passwd database.
type Unix.group_entry = {
|
gr_name : string; |
|
gr_passwd : string; |
|
gr_gid : int; |
|
gr_mem : string array; |
}
Structure of entries in the groups database.
val getlogin : unit -> string
Return the login name of the user executing the process.
val getpwnam : string -> passwd_entry
Find an entry in passwd with the given name, or raise
Not_found.
val getgrnam : string -> group_entry
Find an entry in group with the given name, or raise
Not_found.
val getpwuid : int -> passwd_entry
Find an entry in passwd with the given user id, or raise
Not_found.
val getgrgid : int -> group_entry
Find an entry in group with the given group id, or raise
Not_found.
Internet addresses
type Unix.inet_addr
The abstract type of Internet addresses.
val inet_addr_of_string : string -> inet_addr
Conversion from the printable representation of an Internet
address to its internal representation. The argument string
consists of 4 numbers separated by periods (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.
val string_of_inet_addr : inet_addr -> string
Return the printable representation of the given Internet address.
See
Unix.inet_addr_of_string for a description of the
printable representation.
val inet_addr_any : inet_addr
A special IPv4 address, for use only with bind, representing
all the Internet addresses that the host machine possesses.
val inet_addr_loopback : inet_addr
A special IPv4 address representing the host machine (127.0.0.1).
val inet6_addr_any : inet_addr
A special IPv6 address, for use only with bind, representing
all the Internet addresses that the host machine possesses.
val inet6_addr_loopback : inet_addr
A special IPv6 address representing the host machine (::1).
Sockets
type Unix.socket_domain =
| |
PF_UNIX |
| |
PF_INET |
| |
PF_INET6 |
The type of socket domains. Not all platforms support
IPv6 sockets (type PF_INET6).
type Unix.socket_type =
| |
SOCK_STREAM |
| |
SOCK_DGRAM |
| |
SOCK_RAW |
| |
SOCK_SEQPACKET |
The type of socket kinds, specifying the semantics of
communications.
type Unix.sockaddr =
| |
ADDR_UNIX of string |
| |
ADDR_INET of inet_addr * int |
val socket : domain:socket_domain ->
kind:socket_type -> protocol:int -> file_descr
Create a new socket in the given domain, and with the
given kind. The third argument is the protocol type; 0 selects
the default protocol for that kind of sockets.
val domain_of_sockaddr : sockaddr -> socket_domain
Return the socket domain adequate for the given socket address.
val socketpair : domain:socket_domain ->
kind:socket_type ->
protocol:int -> file_descr * file_descr
Create a pair of unnamed sockets, connected together.
val accept : file_descr -> file_descr * sockaddr
Accept connections on the given socket. The returned descriptor
is a socket connected to the client; the returned address is
the address of the connecting client.
val bind : file_descr -> addr:sockaddr -> unit
Bind a socket to an address.
val connect : file_descr -> addr:sockaddr -> unit
Connect a socket to an address.
val listen : file_descr -> max:int -> unit
Set up a socket for receiving connection requests. The integer
argument is the maximal number of pending requests.
type Unix.shutdown_command =
| |
SHUTDOWN_RECEIVE |
| |
SHUTDOWN_SEND |
| |
SHUTDOWN_ALL |
The type of commands for shutdown.
val shutdown : file_descr -> mode:shutdown_command -> unit
Shutdown a socket connection. 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).
val getsockname : file_descr -> sockaddr
Return the address of the given socket.
val getpeername : file_descr -> sockaddr
Return the address of the host connected to the given socket.
type Unix.msg_flag =
| |
MSG_OOB |
| |
MSG_DONTROUTE |
| |
MSG_PEEK |
val recv : file_descr ->
buf:string -> pos:int -> len:int -> mode:msg_flag list -> int
Receive data from a connected socket.
val recvfrom : file_descr ->
buf:string ->
pos:int ->
len:int -> mode:msg_flag list -> int * sockaddr
Receive data from an unconnected socket.
val send : file_descr ->
buf:string -> pos:int -> len:int -> mode:msg_flag list -> int
Send data over a connected socket.
val sendto : file_descr ->
buf:string ->
pos:int ->
len:int -> mode:msg_flag list -> addr:sockaddr -> int
Send data over an unconnected socket.
Socket options
type
| |
SO_DEBUG |
| |
SO_BROADCAST |
| |
SO_REUSEADDR |
| |
SO_KEEPALIVE |
| |
SO_DONTROUTE |
| |
SO_OOBINLINE |
| |
SO_ACCEPTCONN |
| |
TCP_NODELAY |
| |
IPV6_ONLY |
type
| |
SO_SNDBUF |
| |
SO_RCVBUF |
| |
SO_ERROR |
| |
SO_TYPE |
| |
SO_RCVLOWAT |
| |
SO_SNDLOWAT |
type
type
| |
SO_RCVTIMEO |
| |
SO_SNDTIMEO |
val getsockopt : file_descr -> socket_bool_option -> bool
Return the current status of a boolean-valued option
in the given socket.
val setsockopt : file_descr -> socket_bool_option -> bool -> unit
Set or clear a boolean-valued option in the given socket.
val getsockopt_int : file_descr -> socket_int_option -> int
val setsockopt_int : file_descr -> socket_int_option -> int -> unit
val getsockopt_optint : file_descr -> socket_optint_option -> int option
val setsockopt_optint : file_descr ->
socket_optint_option -> int option -> unit
val getsockopt_float : file_descr -> socket_float_option -> float
Same as
Unix.getsockopt for a socket option whose value is a floating-point number.
val setsockopt_float : file_descr -> socket_float_option -> float -> unit
Same as
Unix.setsockopt for a socket option whose value is a floating-point number.
val getsockopt_error : file_descr -> error option
Return the error condition associated with the given socket,
and clear it.
High-level network connection functions
val open_connection : sockaddr -> in_channel * out_channel
Connect to a server at the given address.
Return a pair of buffered channels connected to the server.
Remember to call
flush on the output channel at the right
times to ensure correct synchronization.
val shutdown_connection : in_channel -> unit
``Shut down'' a connection established with
UnixLabels.open_connection;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.
val establish_server : (in_channel -> out_channel -> unit) ->
addr:sockaddr -> unit
Establish a server on the given address.
The function given as first argument is called for each connection
with two buffered channels connected to the client. A new process
is created for each connection. The function
UnixLabels.establish_server
never returns normally.
Host and protocol databases
type Unix.host_entry = {
}
Structure of entries in the hosts database.
type Unix.protocol_entry = {
|
p_name : string; |
|
p_aliases : string array; |
|
p_proto : int; |
}
Structure of entries in the protocols database.
type Unix.service_entry = {
|
s_name : string; |
|
s_aliases : string array; |
|
s_port : int; |
|
s_proto : string; |
}
Structure of entries in the services database.
val gethostname : unit -> string
Return the name of the local host.
val gethostbyname : string -> host_entry
Find an entry in hosts with the given name, or raise
Not_found.
val gethostbyaddr : inet_addr -> host_entry
Find an entry in hosts with the given address, or raise
Not_found.
val getprotobyname : string -> protocol_entry
Find an entry in protocols with the given name, or raise
Not_found.
val getprotobynumber : int -> protocol_entry
Find an entry in protocols with the given protocol number,
or raise Not_found.
val getservbyname : string -> protocol:string -> service_entry
Find an entry in services with the given name, or raise
Not_found.
val getservbyport : int -> protocol:string -> service_entry
Find an entry in services with the given service number,
or raise Not_found.
type
}
type
| |
AI_FAMILY of socket_domain |
| |
AI_SOCKTYPE of socket_type |
| |
AI_PROTOCOL of int |
| |
AI_NUMERICHOST |
| |
AI_CANONNAME |
| |
AI_PASSIVE |
val getaddrinfo : string ->
string -> getaddrinfo_option list -> addr_info list
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
|
ni_hostname : string; |
|
ni_service : string; |
}
Name of service or port number
Host and service information returned by
Unix.getnameinfo.
type
| |
NI_NOFQDN |
| |
NI_NUMERICHOST |
| |
NI_NAMEREQD |
| |
NI_NUMERICSERV |
| |
NI_DGRAM |
val getnameinfo : sockaddr ->
getnameinfo_option list -> 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.
Terminal interface
The following functions implement the POSIX standard terminal
interface. They provide control over asynchronous communication ports
and pseudo-terminals. Refer to the
termios man page for a
complete description.
type Unix.terminal_io = {
|
mutable c_ignbrk : bool; |
|
mutable c_brkint : bool; |
|
mutable c_ignpar : bool; |
|
mutable c_parmrk : bool; |
|
mutable c_inpck : bool; |
|
mutable c_istrip : bool; |
|
mutable c_inlcr : bool; |
|
mutable c_igncr : bool; |
|
mutable c_icrnl : bool; |
|
mutable c_ixon : bool; |
|
mutable c_ixoff : bool; |
|
mutable c_opost : bool; |
|
mutable c_obaud : int; |
|
mutable c_ibaud : int; |
|
mutable c_csize : int; |
|
mutable c_cstopb : int; |
|
mutable c_cread : bool; |
|
mutable c_parenb : bool; |
|
mutable c_parodd : bool; |
|
mutable c_hupcl : bool; |
|
mutable c_clocal : bool; |
|
mutable c_isig : bool; |
|
mutable c_icanon : bool; |
|
mutable c_noflsh : bool; |
|
mutable c_echo : bool; |
|
mutable c_echoe : bool; |
|
mutable c_echok : bool; |
|
mutable c_echonl : bool; |
|
mutable c_vintr : char; |
|
mutable c_vquit : char; |
|
mutable c_verase : char; |
|
mutable c_vkill : char; |
|
mutable c_veof : char; |
|
mutable c_veol : char; |
|
mutable c_vmin : int; |
|
mutable c_vtime : int; |
|
mutable c_vstart : char; |
|
mutable c_vstop : char; |
}
val tcgetattr : file_descr -> terminal_io
Return the status of the terminal referred to by the given
file descriptor.
type Unix.setattr_when =
| |
TCSANOW |
| |
TCSADRAIN |
| |
TCSAFLUSH |
val tcsetattr : file_descr ->
mode:setattr_when -> terminal_io -> unit
Set the status of the terminal referred to by the given
file descriptor. The second argument indicates when the
status change takes place: immediately (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.
val tcsendbreak : file_descr -> duration:int -> unit
Send a break condition on the given file descriptor.
The second argument is the duration of the break, in 0.1s units;
0 means standard duration (0.25s).
val tcdrain : file_descr -> unit
Waits until all output written on the given file descriptor
has been transmitted.
type Unix.flush_queue =
| |
TCIFLUSH |
| |
TCOFLUSH |
| |
TCIOFLUSH |
val tcflush : file_descr -> mode:flush_queue -> unit
Discard data written on the given file descriptor but not yet
transmitted, or data received but not yet read, depending on the
second argument: TCIFLUSH flushes data received but not read,
TCOFLUSH flushes data written but not transmitted, and
TCIOFLUSH flushes both.
type Unix.flow_action =
| |
TCOOFF |
| |
TCOON |
| |
TCIOFF |
| |
TCION |
val tcflow : file_descr -> mode:flow_action -> unit
Suspend or restart reception or transmission of data on
the given file descriptor, depending on the second argument:
TCOOFF 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 -> int
Put the calling process in a new session and detach it from
its controlling terminal.
The present documentation is copyright Institut National de Recherche en Informatique et en Automatique (INRIA). A complete version can be obtained from
this page.