package eio

  1. Overview
  2. Docs
Effect-based direct-style IO API for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (22)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.6.tbz
sha256=c1f04986b401094176494863dde1ca9b292b59fdc679a9d7023e558d80fb5b15
sha512=92ed8cf20300b8a4e0141bdbc373c0803c5a24530cb65852637d905fff4a5b956a8859a00a424034ff78c1112da9b0391194bcd558326168bdebd1ce683a8890

doc/eio.unix/Eio_unix/Net/index.html

Module Eio_unix.NetSource

Extended network API with support for file descriptors.

Types

These extend the types in Eio.Net with support for file descriptors.

Sourcetype stream_socket_ty = [ `Generic | `Unix ] Eio.Net.stream_socket_ty
Sourcetype datagram_socket_ty = [ `Generic | `Unix ] Eio.Net.datagram_socket_ty
Sourcetype listening_socket_ty = [ `Generic | `Unix ] Eio.Net.listening_socket_ty
Sourcetype 'a stream_socket = ([> stream_socket_ty ] as 'a) Eio.Std.r
Sourcetype 'a datagram_socket = ([> datagram_socket_ty ] as 'a) Eio.Std.r
Sourcetype 'a listening_socket = ([> listening_socket_ty ] as 'a) Eio.Std.r
Sourcetype t = [ `Generic | `Unix ] Eio.Net.ty Eio.Std.r

Passing file descriptors

Sourceval send_msg : [> `Platform of [> `Unix ] | `Socket | `Stream ] Eio.Std.r -> ?fds:Fd.t list -> Cstruct.t list -> unit

Like Eio.Flow.write, but allows passing file descriptors (for Unix-domain sockets).

Sourceval recv_msg_with_fds : [> `Platform of [> `Unix ] | `Socket | `Stream ] Eio.Std.r -> sw:Eio.Std.Switch.t -> max_fds:int -> Cstruct.t list -> int * Fd.t list

Like Eio.Flow.single_read, but also allows receiving file descriptors (for Unix-domain sockets).

  • parameter max_fds

    The maximum number of file descriptors to accept (additional ones will be closed).

Sourceval fd : [> `Platform of [> `Unix ] | `Socket ] Eio.Std.r -> Fd.t

fd socket is the underlying FD of socket.

Unix address conversions

Note: OCaml's Unix.sockaddr type considers e.g. TCP port 80 and UDP port 80 to be the same thing, whereas Eio regards them as separate addresses that just happen to have the same representation (a host address and a port number), so we have separate "of_unix" functions for each.

Sourceval sockaddr_of_unix_stream : Unix.sockaddr -> Eio.Net.Sockaddr.stream
Sourceval sockaddr_of_unix_datagram : Unix.sockaddr -> Eio.Net.Sockaddr.datagram
Sourcemodule Ipaddr : sig ... end

Convert between Eio.Net.Ipaddr and Unix.inet_addr.

Creating or importing sockets

Sourceval import_socket_stream : sw:Eio.Std.Switch.t -> close_unix:bool -> Unix.file_descr -> [< `Unix_fd | stream_socket_ty ] Eio.Std.r

import_socket_stream ~sw ~close_unix fd is an Eio flow that uses fd.

It can be cast to e.g. source for a one-way flow. The socket object will be closed when sw finishes.

The close_unix and sw arguments are passed to Fd.of_unix.

Sourceval import_socket_listening : sw:Eio.Std.Switch.t -> close_unix:bool -> Unix.file_descr -> [< `Unix_fd | listening_socket_ty ] Eio.Std.r

import_socket_listening ~sw ~close_unix fd is an Eio listening socket that uses fd.

The socket object will be closed when sw finishes.

The close_unix and sw arguments are passed to Fd.of_unix.

Sourceval import_socket_datagram : sw:Eio.Std.Switch.t -> close_unix:bool -> Unix.file_descr -> [< `Unix_fd | datagram_socket_ty ] Eio.Std.r

import_socket_datagram ~sw ~close_unix fd is an Eio datagram socket that uses fd.

The socket object will be closed when sw finishes.

The close_unix and sw arguments are passed to Fd.of_unix.

Sourceval socketpair_stream : sw:Eio.Std.Switch.t -> ?domain:Unix.socket_domain -> ?protocol:int -> unit -> [< `Unix_fd | stream_socket_ty ] Eio.Std.r * [< `Unix_fd | stream_socket_ty ] Eio.Std.r

socketpair_stream ~sw () returns a connected pair of flows, such that writes to one can be read by the other.

This creates OS-level resources using socketpair(2). Note that, like all FDs created by Eio, they are both marked as close-on-exec by default.

Sourceval socketpair_datagram : sw:Eio.Std.Switch.t -> ?domain:Unix.socket_domain -> ?protocol:int -> unit -> [< `Unix_fd | datagram_socket_ty ] Eio.Std.r * [< `Unix_fd | datagram_socket_ty ] Eio.Std.r

socketpair_datagram ~sw () returns a connected pair of flows, such that writes to one can be read by the other.

This creates OS-level resources using socketpair(2). Note that, like all FDs created by Eio, they are both marked as close-on-exec by default.

Socket options

Sourcetype Eio.Net.Sockopt.t +=
  1. | Sockopt_bool : Unix.socket_bool_option -> bool Eio.Net.Sockopt.t
    (*

    Wrap any Unix boolean socket option

    *)
  2. | Sockopt_int : Unix.socket_int_option -> int Eio.Net.Sockopt.t
    (*

    Wrap any Unix integer socket option

    *)
  3. | Sockopt_optint : Unix.socket_optint_option -> int option Eio.Net.Sockopt.t
    (*

    Wrap any Unix optional integer socket option

    *)
  4. | Sockopt_float : Unix.socket_float_option -> float Eio.Net.Sockopt.t
    (*

    Wrap any Unix float socket option

    *)

Generic wrappers for Unix socket options. This extends Eio.Net.Sockopt with support for any Unix socket option.

Private API for backends

Sourceval getnameinfo : Eio.Net.Sockaddr.t -> string * string

getnameinfo sockaddr returns domain name and service for sockaddr.

Sourcetype Effect.t +=
  1. | Import_socket_stream : Eio.Std.Switch.t * bool * Unix.file_descr -> [ `Unix_fd | stream_socket_ty ] Eio.Std.r Effect.t
    (*

    See import_socket_stream

    *)
  2. | Import_socket_listening : Eio.Std.Switch.t * bool * Unix.file_descr -> [ `Unix_fd | listening_socket_ty ] Eio.Std.r Effect.t
    (*

    See import_socket_listening

    *)
  3. | Import_socket_datagram : Eio.Std.Switch.t * bool * Unix.file_descr -> [ `Unix_fd | datagram_socket_ty ] Eio.Std.r Effect.t
    (*

    See import_socket_datagram

    *)
  4. | Socketpair_stream : Eio.Switch.t * Unix.socket_domain * int -> ([ `Unix_fd | stream_socket_ty ] Eio.Std.r * [ `Unix_fd | stream_socket_ty ] Eio.Std.r) Effect.t
    (*

    See socketpair_stream

    *)
  5. | Socketpair_datagram : Eio.Switch.t * Unix.socket_domain * int -> ([ `Unix_fd | datagram_socket_ty ] Eio.Std.r * [ `Unix_fd | datagram_socket_ty ] Eio.Std.r) Effect.t
    (*

    See socketpair_datagram

    *)