contrib/serf/serf.h

69 /* This code is for when the connection terminated before the request
100 /* None of the available authn mechanisms for the request are supported */
287  * Accept an incoming response for @a request, and its @a socket. A bucket
292  * The @a acceptor_baton is the baton provided when the specified request
295  * The request's pool and bucket allocator should be used for any allocations
308     serf_request_t *request,
334  * Whenever response data for @a request arrives (initially, or continued data
337  * provided by the request setup callback (@see serf_request_setup_t).
349  * Note: if the connection closed (at the request of the application, or
350  * because of an (abnormal) termination) while a request is being delivered,
352  * signal that the request was not delivered properly, and no further
354  * If a request is injected into the connection (during this callback's
360     serf_request_t *request,
375     serf_request_t *request, void *baton,
392  * When the connection is closed (upon request or because of an error),
424  * When the connection is closed (upon request or because of an error),
472     serf_incoming_request_cb_t request,
496  * Ex.: setting max_requests to 1 means a request is sent when a response on the
497  * previous request was received and handled.
499  * In general, serf tends to take around 16KB per outstanding request.
513  * Setup the @a request for delivery on its connection.
516  * connection's pool for the request to use.  The associated response will
518  * be built. These items may be fetched from the request object through
521  * The content of the request is specified by the @a req_bkt bucket. When
526  * The responsibility for the request bucket is passed to the request
527  * object. When the request is done with the bucket, it will be destroyed.
530     serf_request_t *request,
540  * Construct a request object for the @a conn connection.
542  * When it is time to deliver the request, the @a setup callback will
544  * construction of the request object.
546  * If the request has not (yet) been delivered, then it may be canceled
558  * Construct a request object for the @a conn connection, add it in the
559  * list as the next to-be-written request before all unwritten requests.
561  * When it is time to deliver the request, the @a setup callback will
563  * construction of the request object.
565  * If the request has not (yet) been delivered, then it may be canceled
582 /** Check if a @a request has been completely written.
584  * Returns APR_SUCCESS if the request was written completely on the connection.
585  * Returns APR_EBUSY if the request is not yet or partially written.
588     serf_request_t *request);
591  * Cancel the request specified by the @a request object.
593  * If the request has been scheduled for delivery, then its response
596  * If the request has already been (partially or fully) delivered, then
597  * APR_EBUSY is returned and the request is *NOT* canceled. To properly
598  * cancel the request, the connection must be closed (by clearing or
602     serf_request_t *request);
605  * Return the pool associated with @a request.
612     const serf_request_t *request);
615  * Return the bucket allocator associated with @a request.
618     const serf_request_t *request);
621  * Return the connection associated with @a request.
624     const serf_request_t *request);
627  * Update the @a handler and @a handler_baton for this @a request.
629  * This can be called after the request has started processing -
633     serf_request_t *request,
686  * Create a bucket of type 'request bucket'.
688  * initializes the bucket using request, connection and/or context specific
695     serf_request_t *request,
989  *   of request/response behavior.