package rpc_parallel

  1. Overview
  2. Docs
package rpc_parallel
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Kerberized : sig ... end
type t =
  1. | Kerberized of Kerberized.t
  2. | For_unit_test
include Core.Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
val kerberized : key_source:Krb_public.Server_key_source.t -> conn_type:Krb_public.Conn_type.t -> unit -> t

In this mode, communication to and from workers will use Kerberos for authentication.

key_source must be a valid key source for all the hosts where a worker is running. For example, if your key source specifies a keytab path, that path must have a valid keytab on hosts where you spawn a worker.

conn_type specifies the level of protection for the rpc communication to and from workers. If your application is extremely performance sensitive and sends a lot of data to and from your workers, you should use Auth. Otherwise, using Priv as a default is appropriate. See lib/krb/public/src/conn_type.mli for more documentation.

Regardless of what conn_type you choose, connections will only be accepted from principals that match the principal associated with key_source. By default, this is the principal associated with the user that started the rpc_parallel process.

val for_unit_test : t

In this mode, communication to and from workers will not be kerberized. This is only appropriate if you are running a test.