package rpc_parallel

You can search for identifiers within the package.

in-package search v0.2.0

rpc_parallel
- Rpc_parallel
  - Fd_redirection
  - How_to_run
  - Managed
    
    Make
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    S
    
    Connection_state
    
    Functions
    
    C
    
    Worker_state
    
    Worker
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Map_reduce
    
    Config
    
    Make_map_function
    
    S
    
    Worker
    
    Make_map_function_with_init
    
    S
    
    Worker
    
    Make_map_reduce_function
    
    S
    
    Worker
    
    Make_map_reduce_function_with_init
    
    S
    
    Worker
    
    Map_function
    
    Worker
    
    Map_function_spec
    
    Map_function_with_init_spec
    
    Map_reduce_function
    
    Worker
    
    Map_reduce_function_spec
    
    Map_reduce_function_with_init_spec
    
    Worker
  - Parallel
    
    Backend
    
    Settings
    
    Backend_and_settings
    
    Creator
    
    Expert
    
    Worker_env
    
    For_testing
    
    Function
    
    Direct_pipe
    
    Id
    
    For_internal_testing
    
    Functions
    
    Make
    
    Connection
    
    Deprecated
    
    For_internal_testing
    
    Spawn_in_foreground_result
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    S
    
    Connection_state
    
    Functions
    
    C
    
    Worker_state
    
    Shutdown_on
    
    Spawn_in_foreground_exn_result
    
    Spawn_in_foreground_result
    
    State
    
    Worker
    
    Connection
    
    Deprecated
    
    For_internal_testing
    
    Spawn_in_foreground_result
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Shutdown_on
    
    Spawn_in_foreground_exn_result
    
    Spawn_in_foreground_result
    
    Worker_spec
    
    Connection_state
    
    Functions
    
    C
    
    Worker_state
  - Prog_and_args
  - Remote_executable
  - Rpc_settings
    
    For_internal_testing
  - Utils
    
    Internal_connection_state
    
    Worker_id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Worker_type_id
    
    For_testing
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
rpc_parallel.unauthenticated
- Rpc_parallel_unauthenticated
  - Expert
  - For_testing

Legend:
Library
Module
Module type
Parameter
Class
Class type

A type-safe parallel library built on top of Async_rpc.

module Worker = Rpc_parallel.Make (T : Worker_spec)

The Worker module can be used to spawn new workers, either locally or remotely, and run functions on these workers. T specifies which functions can be run on a Worker.t as well as the implementations for these functions. In addition, T specifies worker states and connection states. See README for more details

module Fd_redirection : sig ... end

module How_to_run : sig ... end

module Map_reduce : sig ... end

A parallel map/reduce library. See examples/add_numbers.ml and examples/number_stats.ml for examples.

module Prog_and_args : sig ... end

module Remote_executable : sig ... end

module Rpc_settings : sig ... end

module Utils : sig ... end

module Managed : sig ... end

include module type of struct include Parallel end

module Function = Parallel.Function

module Backend_and_settings = Parallel.Backend_and_settings

module type Backend = Parallel.Backend

module type Worker = Parallel.Worker

module type Functions = Parallel.Functions

module type Creator = Parallel.Creator

module type Worker_spec = Parallel.Worker_spec

module Make = Parallel.Make

module Worker = Make(T)

val start_app : 
  ?rpc_max_message_size:int ->
  ?rpc_buffer_age_limit:Async.Writer.buffer_age_limit ->
  ?rpc_handshake_timeout:Core.Time_float.Span.t ->
  ?rpc_heartbeat_config:Async.Rpc.Connection.Heartbeat_config.t ->
  ?when_parsing_succeeds:(unit -> unit) ->
  ?complete_subcommands:
    (path:string list -> part:string -> string list list -> string list option) ->
  ?add_validate_parsing_flag:bool ->
  Backend_and_settings.t ->
  Async.Command.t ->
  unit

start_app command should be called from the top-level in order to start the parallel application. This function will parse certain environment variables and determine whether to start as a master or a worker.

rpc_max_message_size, rpc_handshake_timeout, rpc_heartbeat_config can be used to alter the rpc defaults. These rpc settings will be used for all connections. This can be useful if you have long async jobs.

when_parsing_succeeds and complete_subcommands will be passed to Command.run in the master process.

module State = Parallel.State

Use State.get to query whether the current process has been initialized as an rpc parallel master (start_app or init_master_exn has been called). We return a State.t rather than a bool so that you can require evidence at the type level. If you want to certify, as a precondition, for some function that start_app was used, require a State.t as an argument. If you don't need the State.t anymore, just pattern match on it.

module For_testing = Parallel.For_testing

module Expert = Parallel.Expert

If you want more direct control over your executable, you can use the Expert module instead of start_app. If you use Expert, you are responsible for starting the master and worker rpc servers. worker_command_args will be the arguments sent to each spawned worker. Running your executable with these args must follow a code path that calls worker_init_before_async_exn and then start_worker_server_exn. An easy way to do this is to use worker_command.

module Parallel : sig ... end