package ocamlnet

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
exception Closed_channel
exception Broken_communication
exception Watchdog_timeout
exception Timeout
exception Addressing_method_not_supported
exception Cancelled
type !'t engine_state = [
  1. | `Aborted
  2. | `Done of 't
  3. | `Error of exn
  4. | `Working of int
]
type !'t final_state = [
  1. | `Aborted
  2. | `Done of 't
  3. | `Error of exn
]
val string_of_state : 'a engine_state -> string
class type !'t engine = object ... end
class !'t delegate_engine : 't engine -> 't engine
val when_state : ?is_done:('a -> unit) -> ?is_error:(exn -> unit) -> ?is_aborted:(unit -> unit) -> ?is_progressing:(int -> unit) -> 'a engine -> unit
class !'a signal_engine : Unixqueue.event_system -> object ... end
val signal_engine : Unixqueue.event_system -> 'a engine * ('a final_state -> unit)
class ['a, !'b] map_engine : map_done:('a -> 'b engine_state) -> ?map_error:(exn -> 'b engine_state) -> ?map_aborted:(unit -> 'b engine_state) -> ?propagate_working:bool -> 'a engine -> ['a, 'b] engine
val map_engine : map_done:('a -> 'b engine_state) -> ?map_error:(exn -> 'b engine_state) -> ?map_aborted:(unit -> 'b engine_state) -> ?propagate_working:bool -> 'a engine -> 'b engine
class ['a, !'b] fmap_engine : 'a engine -> ('a final_state -> 'b final_state) -> ['a, 'b] engine
val fmap_engine : 'a engine -> ('a final_state -> 'b final_state) -> 'b engine
class !'a meta_engine : 'a engine -> 'a engine
val meta_engine : 'a engine -> 'a final_state engine
val epsilon_engine : 't engine_state -> Unixqueue.event_system -> 't engine
class ['a, !'b] seq_engine : 'a engine -> ('a -> 'b engine) -> ['a, 'b] engine
val seq_engine : 'a engine -> ('a -> 'b engine) -> 'b engine
class ['a, !'b] qseq_engine : 'a engine -> ('a -> 'b engine) -> ['a, 'b] engine
val qseq_engine : 'a engine -> ('a -> 'b engine) -> 'b engine
class !'a stream_seq_engine : 'a -> ('a -> 'a engine) Stream.t -> Unixqueue.event_system -> 'a engine
val stream_seq_engine : 'a -> ('a -> 'a engine) Stream.t -> Unixqueue.event_system -> 'a engine
class [!'a, !'b] sync_engine : 'a engine -> 'b engine -> ['a, 'b] engine
val sync_engine : 'a engine -> 'b engine -> ('a * 'b) engine
class ['a, !'b] msync_engine : 'a engine list -> ('a -> 'b -> 'b) -> 'b -> Unixqueue.event_system -> ['a, 'b] engine
val msync_engine : 'a engine list -> ('a -> 'b -> 'b) -> 'b -> Unixqueue.event_system -> 'b engine
class !'a delay_engine : float -> (unit -> 'a engine) -> Unixqueue.event_system -> 'a engine
val delay_engine : float -> (unit -> 'a engine) -> Unixqueue.event_system -> 'a engine
class !'a timeout_engine : float -> exn -> 'a engine -> 'a engine
val timeout_engine : float -> exn -> 'a engine -> 'a engine
class watchdog : float -> 'a engine -> engine
val watchdog : float -> 'a engine -> unit engine
class type !'a serializer_t = object ... end
val serializer : Unixqueue.event_system -> 'a serializer_t
class type !'a prioritizer_t = object ... end
val prioritizer : Unixqueue.event_system -> 'a prioritizer_t
class type !'a cache_t = object ... end
class !'t engine_mixin : 't engine_state -> Unixqueue.event_system -> object ... end
module Operators : sig ... end
class poll_engine : ?extra_match:(exn -> bool) -> (Unixqueue.operation * float) list -> Unixqueue.event_system -> object ... end
class !'a input_engine : (Unix.file_descr -> 'a) -> Unix.file_descr -> float -> Unixqueue.event_system -> 'a engine
class !'a output_engine : (Unix.file_descr -> 'a) -> Unix.file_descr -> float -> Unixqueue.event_system -> 'a engine
class poll_process_engine : ?period:float -> pid:int -> Unixqueue.event_system -> engine
class type async_out_channel = object ... end
class type async_in_channel = object ... end
class receiver : src:Unix.file_descr -> dst:async_out_channel -> ?close_src:bool -> ?close_dst: bool -> Unixqueue.event_system -> engine
class sender : src:async_in_channel -> dst:Unix.file_descr -> ?close_src:bool -> ?close_dst: bool -> Unixqueue.event_system -> engine
class type async_out_channel_engine = object ... end
class type async_in_channel_engine = object ... end
class output_async_descr : dst:Unix.file_descr -> ?buffer_size:int -> ?close_dst:bool -> Unixqueue.event_system -> async_out_channel_engine
class input_async_descr : src:Unix.file_descr -> ?buffer_size:int -> ?close_src:bool -> Unixqueue.event_system -> async_in_channel_engine
type copy_task = [
  1. | `Bidirectional of Unix.file_descr * Unix.file_descr
  2. | `Tridirectional of Unix.file_descr * Unix.file_descr * Unix.file_descr
  3. | `Uni_socket of Unix.file_descr * Unix.file_descr
  4. | `Unidirectional of Unix.file_descr * Unix.file_descr
]
type inetspec = [
  1. | `Sock_inet of Unix.socket_type * Unix.inet_addr * int
  2. | `Sock_inet_byname of Unix.socket_type * string * int
]
type sockspec = [
  1. | `Sock_inet of Unix.socket_type * Unix.inet_addr * int
  2. | `Sock_inet_byname of Unix.socket_type * string * int
  3. | `Sock_unix of Unix.socket_type * string
]
val sockspec_of_sockaddr : Unix.socket_type -> Unix.sockaddr -> sockspec
val sockspec_of_socksymbol : Unix.socket_type -> Netsockaddr.socksymbol -> sockspec
type connect_address = [
  1. | `Command of string * (int -> Unixqueue.event_system -> unit)
  2. | `Socket of sockspec * connect_options
  3. | `W32_pipe of Netsys_win32.pipe_mode * string
]
and connect_options = Uq_engines.connect_options = {
  1. conn_bind : sockspec option;
}
val default_connect_options : connect_options
type connect_status = [
  1. | `Command of Unix.file_descr * int
  2. | `Socket of Unix.file_descr * sockspec
  3. | `W32_pipe of Unix.file_descr
]
val client_endpoint : connect_status -> Unix.file_descr
val client_socket : connect_status -> Unix.file_descr
class type client_endpoint_connector = object ... end
type listen_options = Uq_engines.listen_options = {
  1. lstn_backlog : int;
  2. lstn_reuseaddr : bool;
}
type listen_address = [
  1. | `Socket of sockspec * listen_options
  2. | `W32_pipe of Netsys_win32.pipe_mode * string * listen_options
]
val default_listen_options : listen_options
class type server_endpoint_acceptor = object ... end
class direct_acceptor : ?close_on_shutdown:bool -> ?preclose:(unit -> unit) -> Unix.file_descr -> Unixqueue.event_system -> server_endpoint_acceptor
class type server_endpoint_listener = object ... end
type datagram_type = [
  1. | `Inet6_udp
  2. | `Inet_udp
  3. | `Unix_dgram
]
class type wrapped_datagram_socket = object ... end
class type datagram_socket_provider = object ... end
class type multiplex_controller = object ... end
exception Mem_not_supported
val create_multiplex_controller_for_connected_socket : ?close_inactive_descr:bool -> ?preclose:(unit -> unit) -> ?supports_half_open_connection:bool -> ?timeout:(float * exn) -> Unix.file_descr -> Unixqueue.unix_event_system -> multiplex_controller
class type datagram_multiplex_controller = object ... end
val create_multiplex_controller_for_datagram_socket : ?close_inactive_descr:bool -> ?preclose:(unit -> unit) -> ?timeout:(float * exn) -> Unix.file_descr -> Unixqueue.unix_event_system -> datagram_multiplex_controller
type onshutdown_out_spec = [
  1. | `Action of async_out_channel_engine -> multiplex_controller -> unit engine_state -> unit
  2. | `Ignore
  3. | `Initiate_shutdown
]
type onshutdown_in_spec = [
  1. | `Action of async_in_channel_engine -> multiplex_controller -> unit engine_state -> unit
  2. | `Ignore
  3. | `Initiate_shutdown
]
class output_async_mplex : ?onclose:[ `Ignore | `Write_eof ] -> ?onshutdown:onshutdown_out_spec -> ?buffer_size: int -> multiplex_controller -> async_out_channel_engine
module Debug : sig ... end
OCaml

Innovation. Community. Security.