o->zo.ce = ce;
http_request_pool_init(&o->pool);
- o->iterator.pos = 0;
ALLOC_HASHTABLE(OBJ_PROP(o));
zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0);
*
* Instantiate a new HttpRequestPool object. An HttpRequestPool is
* able to send several HttpRequests in parallel.
+ *
+ * WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
+ * object while you're using the implemented Interator interface.
*
+ * Accepts virtual infinite optional parameters each referencing an
+ * HttpRequest object.
+ *
+ * Throws HttpRequestException, HttpRequestPoolException, HttpInvalidParamException.
+ *
* Example:
* <pre>
* <?php
* try {
* $pool = new HttpRequestPool(
- * new HttpRequest('http://www.google.com/', HTTP_HEAD),
- * new HttpRequest('http://www.php.net/', HTTP_HEAD)
+ * new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
+ * new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
* );
* $pool->send();
* foreach($pool as $request) {
/* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
*
* Attach an HttpRequest object to this HttpRequestPool.
- * NOTE: set all options prior attaching!
+ * WARNING: set all options prior attaching!
+ *
+ * Expects the parameter to be an HttpRequest object not alread attached to
+ * antother HttpRequestPool object.
+ *
+ * Returns TRUE on success, or FALSE on failure.
+ *
+ * Throws HttpInvalidParamException, HttpRequestException,
+ * HttpRequestPoolException, HttpEncodingException.
*/
PHP_METHOD(HttpRequestPool, attach)
{
/* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
*
* Detach an HttpRequest object from this HttpRequestPool.
+ *
+ * Expects the parameter to be an HttpRequest object attached to this
+ * HttpRequestPool object.
+ *
+ * Returns TRUE on success, or FALSE on failure.
+ *
+ * Throws HttpInvalidParamException, HttpRequestPoolException.
*/
PHP_METHOD(HttpRequestPool, detach)
{
/* {{{ proto bool HttpRequestPool::send()
*
* Send all attached HttpRequest objects in parallel.
+ *
+ * Returns TRUE on success, or FALSE on failure.
+ *
+ * Throws HttpSocketException, HttpRequestException,
+ * HttpRequestPoolException, HttpMalformedHeaderException.
*/
PHP_METHOD(HttpRequestPool, send)
{
}
/* }}} */
-/* {{{ proto protected bool HttpRequestPool::socketSend()
+/* {{{ proto protected bool HttpRequestPool::socketPerform()
*
+ * Returns TRUE until each request has finished its transaction.
+ *
* Usage:
* <pre>
* <?php
/* {{{ proto protected bool HttpRequestPool::socketSelect()
*
* See HttpRequestPool::socketPerform().
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpRequestPool, socketSelect)
{
}
/* }}} */
-/* {{{ proto long HttpRequestPool::key()
+/* {{{ proto int HttpRequestPool::key()
*
* Implements Iterator::key().
*/