include module type of struct include Core.Unix end
Error report
type error = 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
exception Unix_error of Error.t * string * stringRaised 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 unix_error : int -> string -> string -> _val error_message : Error.t -> stringval handle_unix_error : (unit -> 'a) -> 'ahandle_unix_error f runs f () and returns the result. If the exception Unix_error is raised, it prints a message describing the error and exits with code 2.
val retry_until_no_eintr : (unit -> 'a) -> 'aretry_until_no_eintr f returns f () unless f () fails with EINTR; in which case f () is run again until it raises a different error or returns a value.
Access to the process environment
If you're looking for getenv, that's in the Sys module.
val environment : unit -> string arrayReturn the process environment, as an array of strings with the format ``variable=value''.
val putenv : key:string -> data:string -> unitUnix.putenv ~key ~data sets the value associated to a variable in the process environment. key is the name of the environment variable, and data its new associated value.
val unsetenv : string -> unitunsetenv name deletes the variable name from the environment.
EINVAL name contained an ’=’ or an '\000' character.
Process handling
The termination status of a process.
type env = [ | `Replace of (string * string) list| `Extend of (string * string) list| `Replace_raw of string list
]env is used to control the environment of a child process, and can take three forms. `Replace_raw replaces the entire environment with strings in the Unix style, like "VARIABLE_NAME=value". `Replace has the same effect as `Replace_raw, but using bindings represented as "VARIABLE_NAME", "value". `Extend adds entries to the existing environment rather than replacing the whole environment.
If env contains multiple bindings for the same variable, the last takes precedence. In the case of `Extend, bindings in env take precedence over the existing environment.
include sig ... end
val env_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> envval __env_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> envval sexp_of_env : env -> Ppx_sexp_conv_lib.Sexp.texec ~prog ~argv ?search_path ?env execs prog with argv. If use_path = true (the default) and prog doesn't contain a slash, then exec searches the PATH environment variable for prog. If env is supplied, it determines the environment when prog is executed.
The first element in argv should be the program itself; the correct way to call exec is:
exec ~prog ~argv:[ prog; arg1; arg2; ...] ()
fork () forks a new process. The return value indicates whether we are continuing in the child or the parent, and if the parent, includes the child's process id.
wait{,_nohang,_untraced,_nohang_untraced} ?restart wait_on is a family of functions that wait on a process to exit (normally or via a signal) or be stopped by a signal (if untraced is used). The wait_on argument specifies which processes to wait on. The nohang variants return None immediately if no such process exists. If nohang is not used, waitpid will block until one of the desired processes exits.
The non-nohang variants have a restart flag with (default true) that causes the system call to be retried upon EAGAIN|EINTR. The nohang variants do not have this flag because they don't block.
include sig ... end
val wait_on_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> wait_onval __wait_on_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> wait_onval sexp_of_wait_on : wait_on -> Ppx_sexp_conv_lib.Sexp.twaitpid pid waits for child process pid to terminate, and returns its exit status. waitpid_exn is like waitpid, except it only returns if the child exits with status zero, and raises if the child terminates in any other way.
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.
Return the pid of the process.
Return the pid of the parent process.
Return the pid of the parent process, if you're really sure you're never going to be the init process.
Get the numeric ID of the current thread, e.g. for identifying it in top(1).
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.
The abstract type of file descriptors.
File descriptor for standard input.
File descriptor for standard output.
File descriptor for standard standard error.
The flags to UnixLabels.openfile.
type open_flag = Unix.open_flag = | O_RDONLY| O_WRONLY| O_RDWROpen for reading and writing
| O_NONBLOCKOpen in non-blocking mode
| O_APPEND| O_CREAT| O_TRUNCTruncate to 0 length if existing
| O_EXCL| O_NOCTTYDon't make this dev a controlling tty
| O_DSYNCWrites complete as `Synchronised I/O data integrity completion'
| O_SYNCWrites complete as `Synchronised I/O file integrity completion'
| O_RSYNCReads complete as writes (depending on O_SYNC/O_DSYNC)
| O_SHARE_DELETEWindows only: allow the file to be deleted while still open
| O_CLOEXECSet the close-on-exec flag on the descriptor returned by openfile
| O_KEEPEXEC
We can't use with sexp because pa_sexp inserts two copies of the val specs, which leads to a spurious "unused" warning.
include sig ... end
val file_perm_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> file_permval sexp_of_file_perm : file_perm -> Ppx_sexp_conv_lib.Sexp.tOpen 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. Default permissions 0o644.
fcntl_getfl fd gets the current flags for fd from the open-file-descriptor table via the system call fcntl(fd, F_GETFL). See "man fcntl".
fcntl_setfl fd flags sets the flags for fd in the open-file-descriptor table via the system call fcntl(fd, F_SETFL, flags). See "man fcntl". As per the Linux man page, on Linux this only allows append and nonblock to be set.
with_file file ~mode ~perm ~f opens file, and applies f to the resulting file descriptor. When f finishes (or raises), with_file closes the descriptor and returns the result of f (or raises).
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.
write fd buff ofs len writes len characters to descriptor fd, taking them from bytes buff, starting at position ofs in bytes buff. Return the number of characters actually written.
When an error is reported some characters might have already been written. Use single_write instead to ensure that this is not the case.
WARNING: write is an interruptible call and has no way to handle EINTR properly. You should most probably be using single write.
val write_substring : ?pos:int -> ?len:int -> File_descr.t -> buf:string -> intSame as write but with a string buffer.
Same as write but ensures that all errors are reported and that no character has ever been written when an error is reported.
val single_write_substring :
?restart:bool ->
?pos:int ->
?len:int ->
File_descr.t ->
buf:string ->
intSame as single_write but with a string buffer.
val in_channel_of_descr : File_descr.t -> Core__.Import.In_channel.tCreate 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.t -> Core__.Import.Out_channel.tCreate 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 : Core__.Import.In_channel.t -> File_descr.tReturn the descriptor corresponding to an input channel.
val descr_of_out_channel : Core__.Import.Out_channel.t -> File_descr.tReturn the descriptor corresponding to an output channel.
Seeking and truncating
type seek_command = Unix.seek_command = | SEEK_SETindicates positions relative to the beginning of the file
| SEEK_CURindicates positions relative to the current position
| SEEK_ENDindicates positions relative to the end of the file
POSITIONING modes for UnixLabels.lseek.
include sig ... end
val seek_command_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> seek_commandval sexp_of_seek_command : seek_command -> Ppx_sexp_conv_lib.Sexp.tSet the current position for a file descriptor
val truncate : string -> len:int64 -> unitTruncates the named file to the given size.
Truncates the file corresponding to the given descriptor to the given size.
File statistics
type file_kind = Unix.file_kind = | S_REG| S_DIR| S_CHR| S_BLK| S_LNK| S_FIFO| S_SOCK
include sig ... end
val file_kind_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> file_kindval sexp_of_file_kind : file_kind -> Ppx_sexp_conv_lib.Sexp.ttype stats = Unix.LargeFile.stats = {st_dev : int;st_ino : int;st_kind : file_kind;st_perm : file_perm;st_nlink : int;st_uid : int;st_gid : int;Group ID of the file's group
st_rdev : int;st_size : int64;st_atime : float;st_mtime : float;st_ctime : float;
}The informations returned by the UnixLabels.stat calls. The times are float number of seconds since the epoch; we don't use Time.t because Time depends on Unix, so the fix isn't so trivial. Same for Native_file.stats below.
include sig ... end
val stats_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> statsval sexp_of_stats : stats -> Ppx_sexp_conv_lib.Sexp.tval stat : string -> statsReturn the information for the named file.
val lstat : string -> statsSame as UnixLabels.stat, but in case the file is a symbolic link, return the information for the link itself.
Return the information for the file associated with the given descriptor.
This sub-module provides the normal OCaml Unix functions that deal with file size using native ints. These are here because, in general, you should be using 64bit file operations so that large files aren't an issue. If you have a real need to use potentially 31bit file operations (and you should be dubious of such a need) you can open this module
Locking
type lock_command = Unix.lock_command = | F_ULOCK| F_LOCKLock a region for writing, and block if already locked
| F_TLOCKLock a region for writing, or fail if already locked
| F_TESTTest a region for other process locks
| F_RLOCKLock a region for reading, and block if already locked
| F_TRLOCKLock a region for reading, or fail if already locked
include sig ... end
val lock_command_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> lock_commandval sexp_of_lock_command : lock_command -> Ppx_sexp_conv_lib.Sexp.tlockf fd cmd size place a lock on a file_descr that prevents any other process from * calling lockf successfully on the same file. Due to a limitation in the current * implementation the length will be converted to a native int, potentially throwing an * exception if it is too large.
flock fd cmd places or releases a lock on the fd as per the flock C call of the same name.
Return true if the given file descriptor refers to a terminal or console window, false otherwise.
Operations on file names
val unlink : string -> unitval remove : string -> unitRemoves the named file or directory
val rename : src:string -> dst:string -> unitrename old new changes the name of a file from old to new.
val link : ?force:bool -> target:string -> link_name:string -> unit -> unitlink ?force ~target ~link_name () creates a hard link named link_name to the file named target. If force is true, an existing entry in place of link_name will be unlinked. This unlinking may raise a Unix error, e.g. if the entry is a directory.
File permissions and ownership
Change the permissions of the named file.
Change the permissions of an opened file.
val chown : string -> uid:int -> gid:int -> unitChange the owner uid and owner gid of the named file.
Change the owner uid and owner gid of an opened file.
Set the process creation mask, and return the previous mask.
val access :
string ->
[ `Read | `Write | `Exec | `Exists ] list ->
(unit, exn) Core_kernel.Result.tCheck that the process has the given permissions over the named file.
val access_exn : string -> [ `Read | `Write | `Exec | `Exists ] list -> unitOperations on file descriptors
Return a new file descriptor referencing the same file as the given descriptor.
dup2 ~src ~dst duplicates src to dst, closing dst if already opened.
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.
Clear the ``non-blocking'' flag on the given descriptor. See UnixLabels.set_nonblock.
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.
Clear the ``close-on-exec'' flag on the given descriptor. See UnixLabels.set_close_on_exec.
Directories
val mkdir : ?perm:file_perm -> string -> unitCreate a directory. The permissions of the created directory are (perm & ~umask & 0777). The default perm is 0777.
val mkdir_p : ?perm:file_perm -> string -> unitCreate a directory recursively. The permissions of the created directory are those granted by mkdir ~perm.
val rmdir : string -> unitRemove an empty directory.
val chdir : string -> unitChange the process working directory.
val getcwd : unit -> stringReturn the name of the current working directory.
val chroot : string -> unitChange the process root directory.
type dir_handle = Unix.dir_handleThe type of descriptors over opened directories.
val opendir : ?restart:bool -> string -> dir_handleOpen a descriptor on a directory
Return the next entry in a directory. Returns None when the end of the directory has been reached.
Same as readdir_opt except that it signals the end of the directory by raising End_of_file.
Reposition the descriptor to the beginning of the directory
Close a directory descriptor.
Pipes and redirections
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 -> unitCreate a named pipe with the given permissions.
High-level process and redirection management
Low-level process
val create_process : prog:string -> args:string list -> Process_info.tcreate_process ~prog ~args forks a new process that executes the program prog with arguments args. The function returns the pid of the process along with file descriptors attached to stdin, stdout, and stderr of the new process. The executable file prog is searched for in the path. The new process has the same environment as the current process. Unlike in execve the program name is automatically passed as the first argument.
val create_process_env :
?working_dir:string ->
prog:string ->
args:string list ->
env:env ->
unit ->
Process_info.tcreate_process_env ~prog ~args ~env as create_process, but takes an additional parameter that extends or replaces the current environment. No effort is made to ensure that the keys passed in as env are unique, so if an environment variable is set twice the second version will override the first.
val open_process_in : string -> Core__.Import.In_channel.tHigh-level pipe and process management. These functions (with UnixLabels.open_process_out and UnixLabels.open_process) run the given command in parallel with the program, and return channels connected to the standard input and/or the standard output of the command. The command is interpreted by the shell /bin/sh (cf. system). Warning: writes on channels are buffered, hence be careful to call Pervasives.flush at the right times to ensure correct synchronization.
val open_process_out : string -> Core__.Import.Out_channel.tSee UnixLabels.open_process_in.
val open_process :
string ->
Core__.Import.In_channel.t * Core__.Import.Out_channel.tSee UnixLabels.open_process_in.
Similar to UnixLabels.open_process, but the second argument specifies the environment passed to the command. The result is a triple of channels connected to the standard output, standard input, and standard error of the command.
close_process_* raises Unix_error if, for example, the file descriptor has already been closed.
Close channels opened by UnixLabels.open_process_in, wait for the associated command to terminate, and return its termination status.
Close channels opened by UnixLabels.open_process_out, wait for the associated command to terminate, and return its termination status.
val close_process :
(Core__.Import.In_channel.t * Core__.Import.Out_channel.t) ->
Exit_or_signal.tClose channels opened by UnixLabels.open_process, wait for the associated command to terminate, and return its termination status.
Close channels opened by UnixLabels.open_process_full, wait for the associated command to terminate, and return its termination status.
Symbolic links
val symlink : src:string -> dst:string -> unitsymlink source dest creates the file dest as a symbolic link to the file source. On Windows, this has the semantics using stat as described at: http://caml.inria.fr/pub/docs/manual-ocaml/libref/Unix.html
val readlink : string -> stringRead the contents of a link.
Polling
include sig ... end
val sexp_of_select_timeout : select_timeout -> Ppx_sexp_conv_lib.Sexp.tWait until some input/output operations become possible on some channels. The three list arguments are a set of descriptors to check for reading, for writing, or for exceptional conditions. ~timeout is the maximal timeout. The result is composed of three sets of descriptors: those ready for reading, ready for writing, and over which an exceptional condition is pending.
Setting restart to true means that we want select to restart automatically on EINTR (instead of propagating the exception)...
Wait until a non-ignored, non-blocked signal is delivered.
Time functions
type process_times = Unix.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
}The execution times (CPU times) of a process.
include sig ... end
val process_times_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> process_timesval sexp_of_process_times : process_times -> Ppx_sexp_conv_lib.Sexp.ttype tm = Unix.tm = {tm_sec : int;tm_min : int;tm_hour : int;tm_mday : int;tm_mon : int;tm_year : int;tm_wday : int;Day of week (Sunday is 0)
tm_yday : int;tm_isdst : bool;Daylight time savings in effect
}The type representing wallclock time and calendar date.
include sig ... end
val tm_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> tmval sexp_of_tm : tm -> Ppx_sexp_conv_lib.Sexp.tReturn the current time since 00:00:00 GMT, Jan. 1, 1970, in seconds.
val gettimeofday : unit -> floatSame as time above, but with resolution better than 1 second.
Convert a time in seconds, as returned by UnixLabels.time, into a date and a time. Assumes UTC.
Convert a UTC time in a tm record to a time in seconds
val localtime : float -> tmConvert a time in seconds, as returned by UnixLabels.time, into a date and a time. Assumes the local time zone.
val mktime : tm -> float * tmConvert a date and time, specified by the tm argument, into a time in seconds, as returned by UnixLabels.time. 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. The tm argument is interpreted in the local time zone.
val strftime : tm -> string -> stringConvert a date and time, specified by the tm argument, into a formatted string. See 'man strftime' for format options.
Schedule a SIGALRM signal after the given number of seconds.
Stop execution for the given number of seconds.
val nanosleep : float -> floatnanosleep f delays execution of the program for at least f seconds. The function can return earlier if a signal has been delivered, in which case the number of seconds left is returned. Any other failure raises an exception.
Return the execution times of the process.
val utimes : string -> access:float -> modif:float -> unitSet 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.
type interval_timer = Unix.interval_timer = | ITIMER_REALdecrements in real time, and sends the signal SIGALRM when expired.
| ITIMER_VIRTUALdecrements 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.
The three kinds of interval timers.
include sig ... end
val interval_timer_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> interval_timerval sexp_of_interval_timer : interval_timer -> Ppx_sexp_conv_lib.Sexp.ttype interval_timer_status = Unix.interval_timer_status = {it_interval : float;it_value : float;Current value of the timer
}The type describing the status of an interval timer
Return the current status of the given interval timer.
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
It's highly recommended to read the straight unix docs on these functions for more color. You can get that info from man pages or http://www.opengroup.org/onlinepubs/000095399/functions/setuid.html
Return the user id of the user executing the process.
val geteuid : unit -> intReturn the effective user id under which the process runs.
Sets the real user id and effective user id for the process. Only use this when superuser. To setuid as an ordinary user, see Core_extended.Unix.seteuid.
Return the group id of the user executing the process.
val getegid : unit -> intReturn the effective group id under which the process runs.
Set the real group id and effective group id for the process.
Structure of entries in the passwd database
Structure of entries in the groups database.
val getlogin : unit -> stringReturn the login name of the user executing the process.
Internet addresses
A representation of CIDR netmasks (e.g. "192.168.0.0/24") and functions to match if a given address is inside the range or not. Only IPv4 addresses are supported. Values are always normalized so the base address is the lowest IP address in the range, so for example to_string (of_string "192.168.1.101/24") = "192.168.1.0/24".
Sockets
type socket_domain = Unix.socket_domain = | PF_UNIX| PF_INET| PF_INET6
The type of socket domains.
include sig ... end
val socket_domain_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> socket_domainval sexp_of_socket_domain : socket_domain -> Ppx_sexp_conv_lib.Sexp.tval bin_socket_domain : socket_domain Core__.Import.Bin_prot.Type_class.tval bin_read_socket_domain : socket_domain Core__.Import.Bin_prot.Read.readerval __bin_read_socket_domain__ :
(int -> socket_domain) Core__.Import.Bin_prot.Read.readerval bin_reader_socket_domain :
socket_domain Core__.Import.Bin_prot.Type_class.readerval bin_size_socket_domain : socket_domain Core__.Import.Bin_prot.Size.sizerval bin_write_socket_domain : socket_domain Core__.Import.Bin_prot.Write.writerval bin_writer_socket_domain :
socket_domain Core__.Import.Bin_prot.Type_class.writerval bin_shape_socket_domain : Core__.Import.Bin_prot.Shape.ttype socket_type = Unix.socket_type = | SOCK_STREAM| SOCK_DGRAM| SOCK_RAW| SOCK_SEQPACKET
The type of socket kinds, specifying the semantics of communications.
include sig ... end
val socket_type_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> socket_typeval sexp_of_socket_type : socket_type -> Ppx_sexp_conv_lib.Sexp.tval bin_socket_type : socket_type Core__.Import.Bin_prot.Type_class.tval bin_read_socket_type : socket_type Core__.Import.Bin_prot.Read.readerval __bin_read_socket_type__ :
(int -> socket_type) Core__.Import.Bin_prot.Read.readerval bin_reader_socket_type :
socket_type Core__.Import.Bin_prot.Type_class.readerval bin_size_socket_type : socket_type Core__.Import.Bin_prot.Size.sizerval bin_write_socket_type : socket_type Core__.Import.Bin_prot.Write.writerval bin_writer_socket_type :
socket_type Core__.Import.Bin_prot.Type_class.writerval bin_shape_socket_type : Core__.Import.Bin_prot.Shape.ttype sockaddr = Unix.sockaddr = | ADDR_UNIX of string| ADDR_INET of Inet_addr.t * 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.
include sig ... end
val bin_sockaddr : sockaddr Core__.Import.Bin_prot.Type_class.tval bin_read_sockaddr : sockaddr Core__.Import.Bin_prot.Read.readerval __bin_read_sockaddr__ :
(int -> sockaddr) Core__.Import.Bin_prot.Read.readerval bin_reader_sockaddr : sockaddr Core__.Import.Bin_prot.Type_class.readerval bin_size_sockaddr : sockaddr Core__.Import.Bin_prot.Size.sizerval bin_write_sockaddr : sockaddr Core__.Import.Bin_prot.Write.writerval bin_writer_sockaddr : sockaddr Core__.Import.Bin_prot.Type_class.writerval bin_shape_sockaddr : Core__.Import.Bin_prot.Shape.tval sexp_of_sockaddr : sockaddr -> Ppx_sexp_conv_lib.Sexp.tsockaddr_blocking_sexp is like sockaddr, with of_sexp that performs DNS lookup to resolve Inet_addr.t.
include sig ... end
val bin_shape_sockaddr_blocking_sexp : Core__.Import.Bin_prot.Shape.tval domain_of_sockaddr : sockaddr -> socket_domainReturn the socket domain adequate for the given socket address.
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.
Create a pair of unnamed sockets, connected together.
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.
Bind a socket to an address.
Connect a socket to an address.
Set up a socket for receiving connection requests. The integer argument is the number of pending requests that will be established and queued for accept. Depending on operating system, version, and configuration, subsequent connections may be refused actively (as with RST), ignored, or effectively established and queued anyway.
Because handling of excess connections varies, it is most robust for applications to accept and close excess connections if they can. To be sure the client receives an RST rather than an orderly shutdown, you can setsockopt_optint file_descr SO_LINGER
(Some 0) before closing.
In Linux, for example, the system configuration parameters tcp_max_syn_backlog, tcp_abort_on_overflow, and syncookies can all affect connection queuing behavior.
type shutdown_command = Unix.shutdown_command = | SHUTDOWN_RECEIVE| SHUTDOWN_SEND| SHUTDOWN_ALL
The type of commands for shutdown.
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).
Return the address of the given socket.
Return the address of the host connected to the given socket.
type msg_flag = Unix.msg_flag = | MSG_OOB| MSG_DONTROUTE| MSG_PEEK
The flags for UnixLabels.recv, UnixLabels.recvfrom, UnixLabels.send and UnixLabels.sendto.
include sig ... end
val msg_flag_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> msg_flagval sexp_of_msg_flag : msg_flag -> Ppx_sexp_conv_lib.Sexp.tReceive data from a connected socket.
Receive data from an unconnected socket.
Send data over a connected socket.
Same as send but with a string buffer.
Send data over an unconnected socket.
Same as sendto but with a string buffer.
Socket options
type socket_bool_option = | SO_DEBUGRecord debugging information
| SO_BROADCASTPermit sending of broadcast messages
| SO_REUSEADDRAllow reuse of local addresses for bind
| SO_KEEPALIVE| SO_DONTROUTEBypass the standard routing algorithms
| SO_OOBINLINELeave out-of-band data in line
| SO_ACCEPTCONNReport whether socket listening is enabled
| TCP_NODELAYControl the Nagle algorithm for TCP sockets
| IPV6_ONLYForbid binding an IPv6 socket to an IPv4 address
The socket options that can be consulted with UnixLabels.getsockopt and modified with UnixLabels.setsockopt. These options have a boolean (true/false) value.
type socket_int_option = | SO_SNDBUF| SO_RCVBUF| SO_ERRORReport the error status and clear it
| SO_TYPE| SO_RCVLOWATMinimum number of bytes to process for input operations
| SO_SNDLOWATMinimum number of bytes to process for output operations
The socket options that can be consulted with UnixLabels.getsockopt_int and modified with UnixLabels.setsockopt_int. These options have an integer value.
type socket_optint_option = | SO_LINGERWhether to linger on closed connections with sexp that have data present, and for how long (in seconds)
The socket options that can be consulted with UnixLabels.getsockopt_optint and modified with UnixLabels.setsockopt_optint. These options have a value of type int option, with None meaning ``disabled''.
type socket_float_option = | SO_RCVTIMEOTimeout for input operations
| SO_SNDTIMEOTimeout for output operations
The socket options that can be consulted with UnixLabels.getsockopt_float and modified with UnixLabels.setsockopt_float. These options have a floating-point value representing a time in seconds. The value 0 means infinite timeout.
Return the current status of a boolean-valued option in the given socket.
Set or clear a boolean-valued option in the given socket.
Same as UnixLabels.getsockopt for an integer-valued socket option.
Same as UnixLabels.setsockopt for an integer-valued socket option.
Same as UnixLabels.getsockopt for a socket option whose value is an int option.
Same as UnixLabels.setsockopt for a socket option whose value is an int option.
Same as UnixLabels.getsockopt for a socket option whose value is a floating-point number.
Same as UnixLabels.setsockopt for a socket option whose value is a floating-point number.
High-level network connection functions
val open_connection :
sockaddr ->
Core__.Import.In_channel.t * Core__.Import.Out_channel.tConnect to a server at the given address. Return a pair of buffered channels connected to the server. Remember to call Pervasives.flush on the output channel at the right times to ensure correct synchronization.
val shutdown_connection : Core__.Import.In_channel.t -> 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 :
(Core__.Import.In_channel.t -> Core__.Import.Out_channel.t -> unit) ->
addr:sockaddr ->
unitEstablish 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
val gethostname : unit -> stringReturn the name of the local host.
include sig ... end
val sexp_of_addr_info : addr_info -> Ppx_sexp_conv_lib.Sexp.taddr_info_blocking_sexp is like addr_info, with of_sexp that performs DNS lookup to resolve Inet_addr.t.
type getaddrinfo_option = | AI_FAMILY of socket_domainImpose the given socket domain
| AI_SOCKTYPE of socket_typeImpose the given socket type
| AI_PROTOCOL of intImpose the given protocol
| AI_NUMERICHOSTDo not call name resolver, expect numeric IP address
| AI_CANONNAMEFill the ai_canonname field of the result
| AI_PASSIVESet address to ``any'' address for use with Unix.bind
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;Name of service or port number
}include sig ... end
val name_info_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> name_infoval sexp_of_name_info : name_info -> Ppx_sexp_conv_lib.Sexp.ttype getnameinfo_option = | NI_NOFQDNDo not qualify local host names
| NI_NUMERICHOSTAlways return host as IP address
| NI_NAMEREQDFail if host name cannot be determined
| NI_NUMERICSERVAlways return service as port number
| NI_DGRAMConsider the service as UDP-based instead of the default TCP
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.
val get_sockaddr : string -> int -> sockaddrGet a sockaddr from a hostname or IP, and a port
val set_in_channel_timeout : Core__.Import.In_channel.t -> float -> unitSet a timeout for a socket associated with an In_channel.t
val set_out_channel_timeout : Core__.Import.Out_channel.t -> float -> unitSet a timeout for a socket associated with an Out_channel.t
exit_immediately exit_code immediately calls the exit system call with the given exit code without performing any other actions (unlike Pervasives.exit). Does not return.
Filesystem functions
val mknod :
?file_kind:file_kind ->
?perm:int ->
?major:int ->
?minor:int ->
string ->
unitmknod ?file_kind ?perm ?major ?minor path creates a filesystem entry. Note that only FIFO-entries are guaranteed to be supported across all platforms as required by the POSIX-standard. On Linux directories and symbolic links cannot be created with this function. Use Unix.mkdir and Unix.symlink instead there respectively.
I/O vectors
I/O-vectors for scatter/gather-operations
I/O functions
Extract a file descriptor from a directory handle.
Synchronize all filesystem buffers with disk.
Synchronize the kernel buffers of a given file descriptor with disk, but do not necessarily write file attributes.
val readdir_ino_opt : dir_handle -> (string * nativeint) optionreaddir_ino_opt dh return the next entry in a directory (((filename, inode)). Returns None when the end of the directory has been reached.
val readdir_ino : dir_handle -> string * nativeintSame as readdir_ino_opt except that it signals the end of the directory by raising End_of_file.
read_assume_fd_is_nonblocking fd ?pos ?len buf calls the system call read ASSUMING THAT IT IS NOT GOING TO BLOCK. Reads at most len bytes into buffer buf starting at position pos.
write_assume_fd_is_nonblocking fd ?pos ?len buf calls the system call write ASSUMING THAT IT IS NOT GOING TO BLOCK. Writes at most len bytes from buffer buf starting at position pos.
val writev_assume_fd_is_nonblocking :
File_descr.t ->
?count:int ->
string IOVec.t array ->
intwritev_assume_fd_is_nonblocking fd ?count iovecs calls the system call writev ASSUMING THAT IT IS NOT GOING TO BLOCK using count I/O-vectors iovecs.
writev fd ?count iovecs like writev_assume_fd_is_nonblocking, but does not require the descriptor to not block. If you feel you have to use this function, you should probably have chosen I/O-vectors that build on bigstrings, because this function has to internally blit the I/O-vectors (ordinary OCaml strings) to intermediate buffers on the C-heap.
pselect rfds wfds efds timeout sigmask like Core_unix.select but also allows one to wait for the arrival of signals.
type sysconf = | ARG_MAX| CHILD_MAX| HOST_NAME_MAX| LOGIN_NAME_MAX| OPEN_MAX| PAGESIZE| RE_DUP_MAX| STREAM_MAX| SYMLOOP_MAX| TTY_NAME_MAX| TZNAME_MAX| POSIX_VERSION| PHYS_PAGES| AVPHYS_PAGES| IOV_MAX
include sig ... end
val sysconf_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> sysconfval sexp_of_sysconf : sysconf -> Ppx_sexp_conv_lib.Sexp.tval sysconf : sysconf -> int64 optionWrapper over sysconf function in C.
Temporary file and directory creation
mkstemp prefix creates and opens a unique temporary file with prefix, automatically appending a suffix of .tmp. followed by six random characters to make the name unique. Unlike C's mkstemp, prefix should not include six X's at the end.
The file descriptor will have close-on-exec flag set if O_CLOEXEC flag is supported.
val mkdtemp : string -> stringmkdtemp prefix creates a temporary directory with prefix, automatically appending a suffix of .tmp. followed by six random characters to make the name unique.
Signal handling
Causes abnormal program termination unless the signal SIGABRT is caught and the signal handler does not return. If the SIGABRT signal is blocked or ignored, the abort() function will still override it.
User id, group id
val initgroups : string -> int -> unitval getgrouplist : string -> int -> int arraygetgrouplist user group returns the list of groups to which user belongs. See 'man getgrouplist'.
val getgroups : unit -> int arrayReturn the list of groups to which the user executing the process belongs.
Globbing and shell expansion
val fnmatch :
?flags:
[ `No_escape
| `Pathname
| `Period
| `File_name
| `Leading_dir
| `Casefold ]
list ->
pat:string ->
string ->
boolSee man page for wordexp.
Additional IP functionality
val if_indextoname : int -> stringif_indextoname ifindex If ifindex is an interface index, then the function returns the interface name. Otherwise, it raises Unix_error.
mcast_join ?ifname sock addr join a multicast group at addr with socket sock, from source at source if specified, optionally using network interface ifname.
mcast_leave ?ifname sock addr leaves a multicast group at addr with socket sock, optionally using network interface ifname.
get_mcast_ttl sock reads the time-to-live value of outgoing multicast packets for socket sock.
set_mcast_ttl sock ttl sets the time-to-live value of outgoing multicast packets for socket sock to ttl.
get_mcast_loop sock reads the boolean argument that determines whether sent multicast packets are looped back to local sockets.
set_mcast_loop sock loop sets the boolean argument that determines whether sent multicast packets are looped back to local sockets.
set_mcast_ifname sock "eth0" sets outgoing multicast traffic on IPv4 UDP socket sock to go out through interface eth0.
This uses setsockopt with IP_MULTICAST_IF and applies to multicast traffic. For non-multicast applications, see Linux_ext.bind_to_interface.
For keeping your memory in RAM, i.e. preventing it from being swapped out.
A network interface on the local machine. See man getifaddrs.