Extended network API with support for file descriptors.
These extend the types in Eio.Net with support for file descriptors.
type stream_socket_ty = [ `Generic | `Unix ] Eio.Net.stream_socket_tytype datagram_socket_ty = [ `Generic | `Unix ] Eio.Net.datagram_socket_tytype listening_socket_ty = [ `Generic | `Unix ] Eio.Net.listening_socket_tytype 'a stream_socket = [> stream_socket_ty ] as 'a Eio.Std.rtype 'a datagram_socket = [> datagram_socket_ty ] as 'a Eio.Std.rtype 'a listening_socket = [> listening_socket_ty ] as 'a Eio.Std.rtype t = [ `Generic | `Unix ] Eio.Net.ty Eio.Std.rval send_msg :
[> `Platform of [> `Unix ] | `Socket | `Stream ] Eio.Std.r ->
?fds:Fd.t list ->
Cstruct.t list ->
unitLike Eio.Flow.write, but allows passing file descriptors (for Unix-domain sockets).
val 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 listLike Eio.Flow.single_read, but also allows receiving file descriptors (for Unix-domain sockets).
fd socket is the underlying FD of socket.
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.
val sockaddr_to_unix :
[< Eio.Net.Sockaddr.stream | Eio.Net.Sockaddr.datagram ] ->
Unix.sockaddrval sockaddr_of_unix_stream : Unix.sockaddr -> Eio.Net.Sockaddr.streamval sockaddr_of_unix_datagram : Unix.sockaddr -> Eio.Net.Sockaddr.datagrammodule Ipaddr : sig ... endConvert between Eio.Net.Ipaddr and Unix.inet_addr.
val import_socket_stream :
sw:Eio.Std.Switch.t ->
close_unix:bool ->
Unix.file_descr ->
[ `Unix_fd | stream_socket_ty ] Eio.Std.rimport_socket_stream ~sw ~close_unix:true 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.
val import_socket_datagram :
sw:Eio.Std.Switch.t ->
close_unix:bool ->
Unix.file_descr ->
[ `Unix_fd | datagram_socket_ty ] Eio.Std.rimport_socket_datagram ~sw ~close_unix:true 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.
val 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.rsocketpair_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.
val 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.rsocketpair_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.
val getnameinfo : Eio.Net.Sockaddr.t -> string * stringgetnameinfo sockaddr returns domain name and service for sockaddr.
type Effect.t += | Import_socket_stream : Eio.Std.Switch.t
* bool
* Unix.file_descr -> [ `Unix_fd | stream_socket_ty ] Eio.Std.r Effect.t| Import_socket_datagram : Eio.Std.Switch.t
* bool
* Unix.file_descr -> [ `Unix_fd | datagram_socket_ty ] Eio.Std.r Effect.t| 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| 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