Index of values


A
at_fail [Join.Site]
at_fail s c registers channel c as a guard on failure of site s.

C
check_magic [JoinHelper]
Ensures that client and server have the same magic number, raising Error (Magic,...) if not.
client [JoinMapRed.S]
client cfg uses the cfg to connect to the server, and registers itself to receive computations (i.e.
combine [JoinMapRed.Problem]
Used by the server to combine values associated with the same key, compare_keys being used for key equality.
command [JoinTextProc.Sync]
Analogous of JoinProc.command.
command [JoinTextProc.Async]
Analogous of JoinProc.command.
command [JoinProc]
command prog args executes program prog with arguments args in a child process.
compare [Join.Site]
Compare two sites, order is arbitrary.
compare_keys [JoinMapRed.Problem]
Ordering over keys.
connect [JoinHelper]
connect cfg connect as a client to the server referenced by cfg.
connect [JoinCom]
connect (prod,cons,k) connnects producer prod and consumer cons.
create [JoinPool.Shared.S]
Pool creator
create [JoinPool.Simple]
create e comb y0 returns a pool for computations of type 'a -> 'b, comb being used to combine results with initial result y0.
create [JoinFifo]
Create a new fifo buffer.
create [JoinCount.Monitor]
create comb y0 returns a monitor for computations of type 'a -> 'b, comb being used to combine results with initial result y0.
create [JoinCount.Dynamic]
create comb y0 returns a dynamic collector of events of type 'a, with combining function comb and initial result y0.
create [JoinCount.Collector]
create comb y0 n returns a collector of n events of type 'a, with combining function comb and initial result y0.
create [JoinCount.Down]
create n returns a countdown c for n events.
create_prod_cons [JoinFifo]
Create a pair of producer/consumer connected by a fifo.
create_sync [JoinFifo]
Records of type 'a S.t offer the same fields as the ones of type 'a t, but they hold synchronous channels (of functional type)

D
debug [JoinPool.Shared.Config]
If true, gives a few diagnostics on the standard error stream.
debug [Join]
Print a message on standard error.
default_configuration [JoinHelper]
default_configuration () returns a configuration with default values.
do_at_fail [JoinHelper]
do_at_fail f builds a channel that calls f upon failure.
do_forks [JoinHelper]
do_forks prog args n does n forks (none if n is negative), using prog as the program name, and passing args to the forked programs.
do_nothing_at_fail [JoinHelper]
A channel that does noting upon failure.

E
empty [JoinCom.P]
Empty producer, get will always return None.
enum_of_interval [JoinPool.Simple]
enum_of_interval inf sup returns an enumeration that will iterate the interval from int to sup.
enum_of_list [JoinPool.Simple]
enum_of_list l returns an enumeration that will iterate over the elements of l.
equal [Join.Site]
Test the equality of two sites.
exit_at_fail [JoinHelper]
Bare alias for exit_at_fail_with_code 0.
exit_at_fail_with_code [JoinHelper]
exit_at_fail_with_code c builds a channel that terminates the current process with code c upon failure.
exit_hook [Join]
Hook to be given as argument to Pervasives.at_exit.

F
filter_clients [JoinHelper]
filter_clients argv returns a new array identical to the passed one, except that it contains neither the "-clients" switches, nor their arguments.

G
get_local_addr [Join.Site]
Returns the default Internet address of the local site, never fails.

H
here [Join.Ns]
The local name service.
here [Join.Site]
Local site identity.

I
identifier [JoinMapRed.Problem]
The identifier for the problem, used to enable multiple map/reduce problems on a single server.
init_client [JoinMapRed.Problem]
Called at client startup with the data registered at server startup.
init_client [JoinHelper]
init_client ~at_fail cfg initializes a client by connecting it to the server referenced by cfg, forking clients, and registering the at_fail channel to act as a guard on server failure (cf.
init_client_with_lookup [JoinHelper]
init_client_with_lookup ~at_fail ~lookup cfg name behaves as init_client, additionally looking up for name using lookup (defaulting to lookup_times ~-1 1.0) on the returned server name service.
init_server [JoinHelper]
init_server cfg initializes a server listening for connections, registers the magic value, and forks clients.
init_server_with_register [JoinHelper]
init_server_with_register cfg name value executes init_server cfg and uses the returned name service to register value as name.

L
listen [JoinHelper]
listen cfg initializes a server listening for connections and registers the magic value.
listen [Join.Site]
Start to listen for connections on the socket address given as argument.
lookup [Join.Ns]
Find value, raise Not_found when not present, or Join.Exit if attemping to lookup on a failed remote name service.
lookup_once [JoinHelper]
A lookup function that tries to retrieve the value only once, raising Not_found if value is not present and Join.Exit if remote name service is down (alias for Join.Ns.lookup).
lookup_times [JoinHelper]
lookup_times n w builds a lookup function that tries up to n times to retrieve the value, waiting w seconds between two attempts.

M
make_commandline [JoinHelper]
make_configuration cfg returns a list of argument descriptors that will update the configuration cfg when parsed through Arg.parse (or equivalent).
map [JoinMapRed.Problem]
The computation actually done by client agents.
map [JoinCom.P]
map f prod returns a producer that produces f x when prod produces x

N
nagain [JoinPool.Shared.Config]
A given task will be re-issued at most nagain times.

O
of_list [JoinCom.P]
of_list xs returns a producer for the elements of xs
of_site [Join.Ns]
Get remote name service by site identity.
of_sockaddr [Join.Ns]
Synonym for there
of_text [JoinCom.P]
of_text chan returns a producer prod built from the lines of channel chan.
open_full [JoinTextProc.Sync]
Analogous of JoinProc.open_full.
open_full [JoinTextProc.Async]
Analogous of JoinProc.open_full.
open_full [JoinProc]
Redirects all three standard channels of the forked command to pipes.
open_in [JoinTextProc.Sync]
Analogous of JoinProc.open_in.
open_in [JoinTextProc.Async]
Analogous of JoinProc.open_in.
open_in [JoinProc]
Same as JoinProc.command above, except that the forked process standard output is redirected to a pipe, which can be read via the returned input channel.
open_in_out [JoinTextProc.Sync]
Analogous of JoinProc.open_in_out.
open_in_out [JoinTextProc.Async]
Analogous of JoinProc.open_in_out.
open_in_out [JoinProc]
Redirects both standard output and input of the forked command to pipes.
open_out [JoinTextProc.Async]
Analogous of JoinProc.open_out.
open_out [JoinProc]
Same as JoinProc.command above, except that the forked process standard input is redirected to a pipe, which can be written to via the returned output channel.

R
reduce [JoinMapRed.Problem]
Used by the server to fold all client results at the end of the computation.
register [Join.Ns]
Register binding, returns when done.

S
server [JoinMapRed.S]
server cfg i e z sets up a server using the passed configuration, and dispatches tasks to registered clients using a pool.
start [JoinPool.Shared.Enumerable]
Start iterating over a collection, start c returns the initial state
step [JoinPool.Shared.Enumerable]
Iterate once, step st returns None when iteration is over, or Some (e,st') otherwise, where e is the next element and st' is the next explicit state.

T
there [Join.Ns]
Get remote name service by socket address.
there [Join.Site]
Get identity of the remote site listening on sockaddr.
to_list [JoinCom.P]
to_list (prod,k) asynchronously consumes all the elements produced by prod.
to_site [Join.Ns]
Converse operation
to_text [JoinCom.P]
to_text (prod,chan,k) asynchronously consumes all the elements produced by prod, writing lines to channel chan in production order.
to_text_close [JoinCom.P]
Same as JoinCom.P.to_text above except that the channel is closed as sooon as the producer emits None.

W
wait_forever [JoinHelper]
Just waits forever; useful to guarantee that code will not exit prematurely.
when_none [JoinCom.P]
when_none k prod returns a producer that acts like prod.
where_from [Join.Site]
where_from c returns the identity of the remote site where reception on channel c takes place.