ocaml-posix

OCaml bindings to POSIX APIs.

Overview

ocaml-posix provides comprehensive bindings to POSIX system interfaces for OCaml. Each module offers:

• Low-level bindings for use with ocaml-ctypes
• High-level OCaml APIs for convenient, idiomatic usage

This project consolidates and extends various existing POSIX binding libraries into a single, consistent collection.

Documentation

API documentation is available at: http://www.liquidsoap.info/ocaml-posix/

Installation

Via opam (recommended)

opam install posix-base posix-types posix-errno posix-socket posix-time2

From source

git clone https://github.com/savonet/ocaml-posix.git
cd ocaml-posix
opam install .

Quick Start

(* Using posix-time2 for clock operations *)
open Posix_time2

let () =
  let ts = clock_gettime `Realtime in
  Printf.printf "Current time: %Ld.%09ld seconds\n"
    ts.Timespec.tv_sec ts.Timespec.tv_nsec

(* Using posix-uname for system information *)
open Posix_uname

let () =
  let info = uname () in
  Printf.printf "System: %s %s (%s)\n"
    info.sysname info.release info.machine

(* Using posix-socket for DNS resolution *)
open Ctypes
open Posix_socket

let () =
  (* Resolve hostname to socket addresses *)
  let addresses = getaddrinfo ~port:(`Int 443) "example.com" in
  List.iter (fun sockaddr ->
    (* Convert back to human-readable form *)
    let host, port = getnameinfo sockaddr in
    Printf.printf "Resolved: %s:%d\n" host port
  ) addresses

(* Convert between Unix and POSIX socket addresses *)
let unix_to_posix addr =
  let posix_addr = from_unix_sockaddr addr in
  let host, port = getnameinfo posix_addr in
  Printf.printf "Address: %s:%d\n" host port

Available Packages

Package	Description	Replaces
posix-base	Base tools for generating POSIX bindings	-
posix-types	POSIX type definitions	ocaml-posix-types, PosixTypes
posix-errno	Error number handling and Unix error conversion	unix-errno
posix-socket	Socket operations (sys/socket.h)	sys-socket
posix-socket-unix	Unix domain socket extensions	-
posix-time2	Time and clock functions	posix-time, unix-time, posix-clock
posix-getopt	Command-line option parsing	posix-getopt
posix-uname	System identification	-
posix-unistd	Miscellaneous POSIX functions (unistd.h)	-
posix-resource	Resource limits and usage (sys/resource.h)	unix-sys-resource
posix-signal	Signal handling	-
posix-stat	File status (sys/stat.h)	unix-sys-stat
posix-math2	Mathematical functions	-

Cross-compilation

ocaml-posix supports cross-compilation (e.g., building for Windows from Linux/macOS using mingw). The build system automatically detects cross-compilation scenarios and uses appropriate tooling.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.