package paf

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module FLOW : sig ... end
type error = [
  1. | `Read of TCP.error
  2. | `Tls_alert of Tls.Packet.alert_type
  3. | `Tls_failure of Tls.Engine.failure
  4. | `Write of TCP.write_error
]
type write_error = [
  1. | `Closed
  2. | `Read of TCP.error
  3. | `Tls_alert of Tls.Packet.alert_type
  4. | `Tls_failure of Tls.Engine.failure
  5. | `Write of TCP.write_error
]
val pp_error : error Fmt.t
val pp_write_error : write_error Fmt.t
val read : flow -> (Cstruct.t Mirage_flow.or_eof, error) Stdlib.result Lwt.t
val write : flow -> Cstruct.t -> (unit, write_error) Stdlib.result Lwt.t
val writev : flow -> Cstruct.t list -> (unit, write_error) Stdlib.result Lwt.t
val close : flow -> unit Lwt.t
val reneg : ?authenticator:X509.Authenticator.t -> ?acceptable_cas:X509.Distinguished_name.t list -> ?cert:Tls.Config.own_cert -> ?drop:bool -> flow -> (unit, write_error) Stdlib.result Lwt.t
val key_update : ?request:bool -> flow -> (unit, write_error) Stdlib.result Lwt.t
val client_of_flow : Tls.Config.client -> ?host:string -> FLOW.flow -> (flow, write_error) Stdlib.result Lwt.t
val server_of_flow : Tls.Config.server -> FLOW.flow -> (flow, write_error) Stdlib.result Lwt.t
val epoch : flow -> (Tls.Core.epoch_data, unit) Stdlib.result
OCaml

Innovation. Community. Security.