package ocamlnet

  1. Overview
  2. Docs
package ocamlnet
Legend:
Library
Module
Module type
Parameter
Class
Class type
type config
type credentials
type endpoint
val error_message : string -> string
type dh_params = [
  1. | `Generate of int
  2. | `PKCS3_DER of string
  3. | `PKCS3_PEM_file of string
]
val create_config : ?algorithms:string -> ?dh_params:dh_params -> ?verify:(endpoint -> bool -> bool -> bool) -> peer_auth:[ `None | `Optional | `Required ] -> credentials:credentials -> unit -> config
type crt_list = [
  1. | `DER of string list
  2. | `PEM_file of string
]
type crl_list = [
  1. | `DER of string list
  2. | `PEM_file of string
]
type private_key = [
  1. | `DSA of string
  2. | `EC of string
  3. | `PEM_file of string
  4. | `PKCS8 of string
  5. | `PKCS8_encrypted of string
  6. | `RSA of string
]
val create_x509_credentials : ?system_trust:bool -> ?trust:crt_list list -> ?revoke:crl_list list -> ?keys:(crt_list * private_key * string option) list -> unit -> credentials
val create_endpoint : role:[ `Client | `Server ] -> recv:(Netsys_types.memory -> int) -> send:(Netsys_types.memory -> int -> int) -> peer_name:string option -> config -> endpoint
val stash_endpoint : endpoint -> exn
val restore_endpoint : recv:(Netsys_types.memory -> int) -> send:(Netsys_types.memory -> int -> int) -> exn -> endpoint
val resume_client : recv:(Netsys_types.memory -> int) -> send:(Netsys_types.memory -> int -> int) -> peer_name:string option -> config -> string -> endpoint
type state = [
  1. | `Accepting
  2. | `Data_r
  3. | `Data_rs
  4. | `Data_rw
  5. | `Data_w
  6. | `End
  7. | `Handshake
  8. | `Refusing
  9. | `Start
  10. | `Switching
]
val get_state : endpoint -> state
type raw_credentials = [
  1. | `Anonymous
  2. | `X509 of string
]
val at_transport_eof : endpoint -> bool
val hello : endpoint -> unit
val bye : endpoint -> Unix.shutdown_command -> unit
val verify : endpoint -> unit
val get_config : endpoint -> config
val get_endpoint_creds : endpoint -> raw_credentials
val get_peer_creds : endpoint -> raw_credentials
val get_peer_creds_list : endpoint -> raw_credentials list
val switch : endpoint -> config -> unit
val accept_switch : endpoint -> config -> unit
val refuse_switch : endpoint -> unit
val send : endpoint -> Netsys_types.memory -> int -> int
val recv : endpoint -> Netsys_types.memory -> int
val recv_will_not_block : endpoint -> bool
val get_session_id : endpoint -> string
val get_session_data : endpoint -> string
val get_cipher_suite_type : endpoint -> string
val get_cipher_algo : endpoint -> string
val get_kx_algo : endpoint -> string
val get_mac_algo : endpoint -> string
val get_compression_algo : endpoint -> string
val get_cert_type : endpoint -> string
val get_protocol : endpoint -> string
type server_name = [
  1. | `Domain of string
]
val get_addressed_servers : endpoint -> server_name list
val set_session_cache : store:(string -> string -> unit) -> remove:(string -> unit) -> retrieve:(string -> string) -> endpoint -> unit
val implementation_name : string
val implementation : unit -> exn
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct