Source file `protocol_backend_intf.ml`

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
open Core
open Async
open! Import

(** [Protocol_backend.S] is a signature of a module providing binprot reading and writing
    which [Protocol] uses for initial handshake. *)
module type S = sig
  type t

  (** This can raise in certain backends if, e.g. the connection is closed. *)
  val write_bin_prot_exn : t -> 'a Bin_prot.Type_class.writer -> 'a -> unit

  val read_bin_prot
    :  t
    -> 'a Bin_prot.Type_class.reader
    -> [ `Ok of 'a | `Eof ] Deferred.t

  val info : t -> Info.t
  val local_inet : t -> Socket.Address.Inet.t
  val remote_inet : t -> Socket.Address.Inet.t
end