Index of values


A
accept_into_set [Procord_connection]
Accept new connections from a socket and add them to a set of connections.
alive [Procord_connection]
Return whether a connection is alive.

B
blocking_receive [Procord_protocol]
Receive a message.
blocking_receive_task_name [Procord_protocol]
Receive a task name.
blocking_receive_value [Procord_protocol]
Receive a serialized value.

C
close [Procord_connection]
Close a connection if it is not closed already.
close_nicely [Procord_connection.Sync]
Same as close_nicely, but wait until the connection is closed.
close_nicely [Procord_connection]
Same as close, but wait until all data is sent first.
concat [Procord_rope]
Rope concatenation.
connect [Procord_connection.Sync]
Same as connect, but wait until the connection is established.
connect [Procord_connection]
Connect to a server using a socket.
custom [Procord_connection]
Create a connection from custom file descriptors.

D
data [Procord_connection]
Get the data associated to a connection.
delegate [Procord_process]
Delegate according to command-line options parsed by Procord_worker.run.
delegate_task_create_process [Procord_process]
Delegate a task, running it in another process on the current machine.
delegate_task_socket [Procord_process]
Delegate a task, running it in another process on a remote machine.
delegated_task_name [Procord_task]
Get the name of a delegated task.

E
empty [Procord_rope]
The empty rope.
empty_set [Procord_connection]
Create a new empty set of connections.
error [Procord_protocol]
Raise an error.
error_message [Procord_protocol]
Return a string explaining an error in English.
error_message [Procord_process]
Return a string explaining an error in English.

F
formatter_of_destination [Procord_protocol]
Return the formatter corresponding to a destination.

G
get_dont_fork [Procord_worker]
Get the --procord-dont-fork argument.
get_hostname [Procord_worker]
Get the --procord-hostname argument.
get_input_file [Procord_worker]
Get the --procord-input-file argument.
get_max_simultaneous_tasks [Procord_worker]
Get the --procord-max-simultaneous-tasks argument.
get_output_file [Procord_worker]
Get the --procord-output-file argument.
get_port [Procord_worker]
Get the --procord-port argument.
get_reuse_address [Procord_worker]
Get the --procord-reuse-address argument.

I
instanciate_waiter [Procord_connection]
Get the file descriptor lists for Unix.select from a waiter.
is_empty [Procord_rope]
Test whether a rope is empty.
iter [Procord_connection]
Iterate on all connections of a connection set.
iter_string_pieces [Procord_rope]
Iterate on the string pieces of a rope.

K
kill [Procord_process]
Terminate a process immediately.

L
length [Procord_rope]
Return the length, in bytes, of a rope.

M
make [Procord_task]
Make a worker_task and a delegated_task.
make_address [Procord_connection]
Make a socket address from an IPv4, IPv6 or DNS address.
make_delegated_task [Procord_task]
Make a delegated_task.
make_redirected_formatter [Procord_worker]
Create a new formatter which is already redirected.
make_worker_task [Procord_task]
Make a worker_task.

O
of_string [Procord_rope]
Make a rope from a string.

R
read_exception [Procord_task]
Get the exception deserialization function of a delegated task, if any.
read_input [Procord_task]
Get the input deserialization function of a worker task.
read_output [Procord_task]
Get the output deserialization function of a delegated task.
receive [Procord_protocol]
Try to receive a message from a connection.
receive [Procord_connection.Sync]
Same as receive, but wait until the data is available.
receive [Procord_connection]
Receive data from a connection.
receive_all [Procord_connection]
Same as receive, but receive everything.
receive_buffer_empty [Procord_connection]
Return whether the receive buffer is empty.
receive_buffer_length [Procord_connection]
Return the length of the receive buffer.
receive_forget [Procord_connection]
Same as receive, but do not actually return the received data.
receive_part [Procord_connection]
Same as receive, but may receive less data than requested.
receive_poll [Procord_connection]
Same as receive, but do not remove the data from the buffer.
receive_poll_part [Procord_connection]
Same as receive_poll, but may receive less data than requested.
redirect_formatter [Procord_worker]
Redirect a formatter.
redirect_standard_formatters [Procord_worker]
Redirect Format.std_formatter and Format.err_formatter to the main program.
register_destination [Procord_protocol]
Register a formatter as a custom destination.
remote_address [Procord_connection]
Get the remote address of a connection.
run [Procord_worker]
Parse command-line options and run the appropriate worker, if any.
run [Procord_task]
Get the function that a worker task runs.
run [Procord_process]
Wait (blocking) until a process terminates.
run_custom [Procord_worker]
Run a worker which will accomplish one task amongst several on given file descriptors.
run_listen [Procord_worker]
Run a worker which will listen for network connections.

S
send [Procord_protocol]
Send a message.
send [Procord_connection.Sync]
Same as send, but wait until the sending buffer is empty.
send [Procord_connection]
Send data to a connection.
send_error [Procord_protocol]
Send an error message.
send_exception [Procord_protocol]
Send an exception message.
send_flush [Procord_protocol]
Send a flush request.
send_print [Procord_protocol]
Send a message to be printed using Format.fprintf.
send_task_name [Procord_protocol]
Send the name of the task to execute.
send_unknown_exception [Procord_protocol]
Send an unknown exception message.
send_value [Procord_protocol]
Send a value (input or output).
set_dont_fork [Procord_worker]
Set the --procord-dont-fork argument.
set_hostname [Procord_worker]
Set the --procord-hostname argument.
set_input_file [Procord_worker]
Set the --procord-input-file argument.
set_max_message_size [Procord_protocol]
Set the maximum size of packets.
set_max_simultaneous_tasks [Procord_worker]
Set the --procord-max-simultaneous-tasks argument.
set_output_file [Procord_worker]
Set the --procord-output-file argument.
set_port [Procord_worker]
Set the --procord-port argument.
set_reuse_address [Procord_worker]
Set the --procord-reuse-address argument.
state [Procord_connection]
Get the state of the connection at the last update.
status [Procord_process]
Get the current status of a process.
sub [Procord_rope]
Make a rope from a part of another rope.

T
task [Procord_worker]
Embed a Procord_task.worker_task for use with Procord_worker.run.
timeout [Procord_connection]
Get the timeout argument which was passed to connect or custom.
to_string [Procord_rope]
Convert a rope back into a string.

U
update [Procord_process]
Call this regularly to update the process_status.
update [Procord_connection]
Update a connection.
update_set [Procord_connection]
Update all connections of a set, and remove closed connections.

W
wait [Procord_connection]
Wait until something new happens.
wait' [Procord_connection]
Same as wait but ignore the result.
waiter [Procord_process]
Return a waiter which waits until something happens for a process.
waiter [Procord_connection]
Make a waiter from a connection.
waiter_custom [Procord_connection]
Make a custom waiter from file descriptors.
waiter_of_list [Procord_connection]
Make a waiter from a list of waiters.
waiter_of_listening_socket [Procord_connection]
Make a waiter from a listening socket.
waiter_of_set [Procord_connection]
Make a waiter from a set of connections.
worker_task_name [Procord_task]
Get the name of a worker task.
write_exception [Procord_task]
Get the exception serialization function of a worker task.
write_input [Procord_task]
Get the input serialization function of a delegated task.
write_output [Procord_task]
Get the output serialization function of a worker task.