X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_requestpool_object.c;h=f4f0f9918359b71208561205ff763f37631e764b;hp=e01e26d21db5f8066a0119572b48c69fd3628664;hb=1f4974565dc58da9c7bfbde278896a5e06e9d669;hpb=c4d95e923b40160d814c7e4e0a822332bbd65bdb diff --git a/http_requestpool_object.c b/http_requestpool_object.c index e01e26d..f4f0f99 100644 --- a/http_requestpool_object.c +++ b/http_requestpool_object.c @@ -58,9 +58,8 @@ HTTP_BEGIN_ARGS(detach, 1) HTTP_END_ARGS; HTTP_EMPTY_ARGS(send, 0); -HTTP_EMPTY_ARGS(socketSend, 0); +HTTP_EMPTY_ARGS(socketPerform, 0); HTTP_EMPTY_ARGS(socketSelect, 0); -HTTP_EMPTY_ARGS(socketRead, 0); HTTP_EMPTY_ARGS(valid, 0); HTTP_EMPTY_ARGS(current, 1); @@ -80,9 +79,8 @@ zend_function_entry http_requestpool_object_fe[] = { HTTP_REQPOOL_ME(send, ZEND_ACC_PUBLIC) HTTP_REQPOOL_ME(reset, ZEND_ACC_PUBLIC) - HTTP_REQPOOL_ME(socketSend, ZEND_ACC_PROTECTED) + HTTP_REQPOOL_ME(socketPerform, ZEND_ACC_PROTECTED) HTTP_REQPOOL_ME(socketSelect, ZEND_ACC_PROTECTED) - HTTP_REQPOOL_ME(socketRead, ZEND_ACC_PROTECTED) /* implements Interator */ HTTP_REQPOOL_ME(valid, ZEND_ACC_PUBLIC) @@ -91,7 +89,7 @@ zend_function_entry http_requestpool_object_fe[] = { HTTP_REQPOOL_ME(next, ZEND_ACC_PUBLIC) HTTP_REQPOOL_ME(rewind, ZEND_ACC_PUBLIC) - {NULL, NULL, NULL} + EMPTY_FUNCTION_ENTRY }; static zend_object_handlers http_requestpool_object_handlers; @@ -110,7 +108,6 @@ zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC) 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); @@ -147,14 +144,22 @@ void _http_requestpool_object_free(zend_object *object TSRMLS_DC) * * 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: *
  * send();
  *     foreach($pool as $request) {
@@ -219,7 +224,15 @@ PHP_METHOD(HttpRequestPool, reset)
 /* {{{ 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)
 {
@@ -239,6 +252,13 @@ 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)
 {
@@ -258,6 +278,11 @@ 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)
 {
@@ -274,34 +299,42 @@ PHP_METHOD(HttpRequestPool, send)
 }
 /* }}} */
 
-/* {{{ proto protected bool HttpRequestPool::socketSend()
+/* {{{ proto protected bool HttpRequestPool::socketPerform()
  *
+ * Returns TRUE until each request has finished its transaction.
+ * 
  * Usage:
  * 
  * socketSend()) {
+ *     while ($pool->socketPerform()) {
  *         do_something_else();
  *         if (!$pool->socketSelect()) {
  *             die('Socket error');
  *         }
  *     }
- *     $pool->socketRead();
  * ?>
  * 
*/ -PHP_METHOD(HttpRequestPool, socketSend) +PHP_METHOD(HttpRequestPool, socketPerform) { getObject(http_requestpool_object, obj); NO_ARGS; - RETURN_BOOL(0 < http_request_pool_perform(&obj->pool)); + if (0 < http_request_pool_perform(&obj->pool)) { + RETURN_TRUE; + } else { + zend_llist_apply(&obj->pool.handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC); + RETURN_FALSE; + } } /* }}} */ /* {{{ proto protected bool HttpRequestPool::socketSelect() * - * See HttpRequestPool::socketSend(). + * See HttpRequestPool::socketPerform(). + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpRequestPool, socketSelect) { @@ -313,20 +346,6 @@ PHP_METHOD(HttpRequestPool, socketSelect) } /* }}} */ -/* {{{ proto protected void HttpRequestPool::socketRead() - * - * See HttpRequestPool::socketSend(). - */ -PHP_METHOD(HttpRequestPool, socketRead) -{ - getObject(http_requestpool_object, obj); - - NO_ARGS; - - zend_llist_apply(&obj->pool.handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC); -} -/* }}} */ - /* implements Iterator */ /* {{{ proto bool HttpRequestPool::valid() @@ -371,7 +390,7 @@ PHP_METHOD(HttpRequestPool, current) } /* }}} */ -/* {{{ proto long HttpRequestPool::key() +/* {{{ proto int HttpRequestPool::key() * * Implements Iterator::key(). */