class pipeline :A pipeline is a queue of HTTP calls to perform
pipeline object is a FIFO queue of HTTP calls. It is called
"pipeline" because it is processed asynchronously: Requests may be
sent to the HTTP server independently of whether responses of the
previous requests already arrived or not.
pipeline object may keep connections to several
servers at once. (More exactly, it has a FIFO queue for every
server it is connected with.)
pipeline object keeps track what is happening, so you need
not to care about the details of communications. The API is
simple: Create a
pipeline object, do some setup (add authentication
methods; configure the proxy to use), add the requests, and
run the pipeline. The rest is done automatically. To get the results,
you can either memorize the requests you wanted to know yourself
and ask every request object about the reply of the server; or
you can specify that a callback function should be called once
the request is processed (with positive or negative result).
It is possible to add further requests to the pipeline from within
these callback functions.
If you want to have several pipelines, or some cooperation with
other network services, you may specify a
For example, to have two pipelines working concurrently:
let ues = Unixqueue.create_unix_event_system() in
let p1 = new pipeline in
let p2 = new pipeline in
p1 # set_event_system ues;
p2 # set_event_system ues;
Unixqueue.run ues (* run p1 and p2 in parallel *)
This works not only with pipelines, but with every network client
or server which is compatible with the
method event_system :
method set_event_system :
Unixqueue.event_system -> unit
method connection_cache :
method set_connection_cache :
connection_cache -> unit
method add_authentication_method :
basic_auth_method -> unit
method add_auth_handler :
auth_handler -> unit
set_proxy name port:
sets that a proxy
name listening on
port is to be used
and set the proxy options from them.
No_reply (i.e. you get the exception
No_reply if you try to access the response).
If there are callbacks for these requests, the callback
functions are invoked.
The queues of open requests and replies are cleared. All
connections to all servers are inactivated.
Inactivation means that open connections are given back
to the connection cache for further reuse if the state
of the connection allows this; otherwise the connections are
method add :
http_call -> unit
After the call has been processed, the callback function
is called. This function is called for every call that
leaves the pipeline, it does not matter whether processing
was successful or not. Invoke
status on the message
to get what happened; either some status information from the
server is available (perhaps OK status), or an exception is
object and will be raised once the state of the object is
Under certain conditions (serious network errors)
not catch the exception; it simply cleans its own state up
(aborting the errorneous network connection). In this case,
run again to continue.
run terminates normally if the pipeline becomes empty.
The engine handles the following HTTP return codes itself:
method get_options :
method set_options :
http_options -> unit
(host, port, queue_length)
cnt_new_connections: Is increased when a new connection attempt
is started (that may fail or timeout in the future). Reconnects
do not count.
cnt_timed_out_connections: Is increased whenever an established
connection times out. Usually, it is immediately reconnected.
cnt_crashed_connections: Is increased whenever an established
connection crashes. Usually, it is immediately reconnected.
cnt_failed_connections: Is increased when a timed out or
crashed connection exceeds the maximum number of errors, and it is
not tried to reconnect.
cnt_successful_connections: Is increased when all HTTP calls
have been replied.
cnt_new_connections = cnt_failed_connections + cnt_successful_connections