package letsencrypt-mirage

  1. Overview
  2. Docs
package letsencrypt-mirage
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Paf.TLSSource

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
Sourcetype flow = Paf_mirage.Make(Stack.TCP).TLS.flow
Sourceval read : flow -> (Cstruct.t Mirage_flow.or_eof, error) result Lwt.t
Sourceval write : flow -> Cstruct.t -> (unit, write_error) result Lwt.t
Sourceval writev : flow -> Cstruct.t list -> (unit, write_error) result Lwt.t
Sourceval shutdown : flow -> [ `read | `read_write | `write ] -> unit Lwt.t
Sourceval close : flow -> unit Lwt.t
Sourceval no_close : flow -> unit
Sourceval to_close : flow -> unit
Sourceval epoch : flow -> (Tls.Core.epoch_data, unit) result
Sourceval reneg : ?authenticator:X509.Authenticator.t -> ?acceptable_cas:X509.Distinguished_name.t list -> ?cert:Tls.Config.own_cert -> ?drop:bool -> flow -> (unit, [ `Closed | `Msg of string | `Read of TCP.error | `Tls_alert of Tls.Packet.alert_type | `Tls_failure of Tls.Engine.failure | `Write of TCP.write_error ]) result Lwt.t
Sourceval key_update : ?request:bool -> flow -> (unit, [ `Closed | `Msg of string | `Read of TCP.error | `Tls_alert of Tls.Packet.alert_type | `Tls_failure of Tls.Engine.failure | `Write of TCP.write_error ]) result Lwt.t
Sourceval server_of_flow : Tls.Config.server -> TCP.flow -> (flow, write_error) result Lwt.t
Sourceval client_of_flow : Tls.Config.client -> ?host:[ `host ] Domain_name.t -> TCP.flow -> (flow, write_error) result Lwt.t