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);
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)
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;
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);
zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
- ov.handle = zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, http_requestpool_object_free, NULL TSRMLS_CC);
+ ov.handle = putObject(http_requestpool_object, o);
ov.handlers = &http_requestpool_object_handlers;
return ov;
*
* 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) {
* printf("%s is %s (%d)\n",
- * $request->getResponseInfo('effective_url'),
+ * $request->getUrl(),
* $request->getResponseCode() ? 'alive' : 'not alive',
* $request->getResponseCode()
* );
/* {{{ 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
- * while ($pool->socketSend()) {
+ * while ($pool->socketPerform()) {
* do_something_else();
* if (!$pool->socketSelect()) {
* die('Socket error');
* }
* }
- * $pool->socketRead();
* ?>
* </pre>
*/
-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)
{
}
/* }}} */
-/* {{{ 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()
+ *
+ * Implements Iterator::valid().
*/
PHP_METHOD(HttpRequestPool, valid)
{
/* }}} */
/* {{{ proto HttpRequest HttpRequestPool::current()
+ *
+ * Implements Iterator::current().
*/
PHP_METHOD(HttpRequestPool, current)
{
getObject(http_requestpool_object, obj);
if (obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
- for ( current = zend_llist_get_first_ex(&obj->pool.handles, &lpos);
- current && obj->iterator.pos != pos++;
+ for ( current = zend_llist_get_first_ex(&obj->pool.handles, &lpos);
+ current && obj->iterator.pos != pos++;
current = zend_llist_get_next_ex(&obj->pool.handles, &lpos));
if (current) {
RETURN_OBJECT(*current);
}
/* }}} */
-/* {{{ proto long HttpRequestPool::key()
+/* {{{ proto int HttpRequestPool::key()
+ *
+ * Implements Iterator::key().
*/
PHP_METHOD(HttpRequestPool, key)
{
/* }}} */
/* {{{ proto void HttpRequestPool::next()
+ *
+ * Implements Iterator::next().
*/
PHP_METHOD(HttpRequestPool, next)
{
/* }}} */
/* {{{ proto void HttpRequestPool::rewind()
+ *
+ * Implements Iterator::rewind().
*/
PHP_METHOD(HttpRequestPool, rewind)
{