package hvsock

  1. Overview
  2. Docs
type error = [
  1. | `Unix of Unix.error
]
include Mirage_flow_combinators.SHUTDOWNABLE with type error := error
include Mirage_flow.S with type error := error
val pp_error : error Fmt.t
type nonrec write_error = private [>
  1. | Mirage_flow.write_error
]
val pp_write_error : write_error Fmt.t
type flow
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 shutdown_write : flow -> unit Lwt.t

Close the write direction of the flow, flushing any buffered data and causing future calls to read by the peer to return `Eof.

val shutdown_read : flow -> unit Lwt.t

Close the read direction of the flow, such that future calls to write by the peer will return `Eof

val read_into : flow -> Cstruct.t -> (unit Mirage_flow.or_eof, error) Stdlib.result Lwt.t
val connect : Socket.t -> flow
OCaml

Innovation. Community. Security.