+ **Iterator API integration**: Added zend_async_iterator_t structure to TrueAsync API with run() and run_in_coroutine() methods

Author: EdmondDantes

Zend/zend_async_API.c

@@ -107,6 +107,9 @@ zend_async_new_trigger_event_t zend_async_new_trigger_event_fn = NULL;
 static zend_string * thread_pool_module_name = NULL;
 zend_async_queue_task_t zend_async_queue_task_fn = NULL;
 
+/* Iterator API */
+zend_async_new_iterator_t zend_async_new_iterator_fn = NULL;
+
 /* Context API */
 zend_async_new_context_t zend_async_new_context_fn = new_context;
 
@@ -203,7 +206,8 @@ ZEND_API bool zend_async_scheduler_register(
     zend_async_get_coroutines_t get_coroutines_fn,
     zend_async_add_microtask_t add_microtask_fn,
     zend_async_get_awaiting_info_t get_awaiting_info_fn,
-    zend_async_get_class_ce_t get_class_ce_fn
+    zend_async_get_class_ce_t get_class_ce_fn,
+    zend_async_new_iterator_t new_iterator_fn
 )
 {
 	if (zend_atomic_bool_exchange(&scheduler_lock, 1)) {
@@ -238,6 +242,7 @@ ZEND_API bool zend_async_scheduler_register(
     zend_async_add_microtask_fn = add_microtask_fn;
 	zend_async_get_awaiting_info_fn = get_awaiting_info_fn;
 	zend_async_get_class_ce_fn = get_class_ce_fn;
+	zend_async_new_iterator_fn = new_iterator_fn;
 
 	zend_atomic_bool_store(&scheduler_lock, 0);
 

Zend/zend_async_API.h

@@ -118,6 +118,7 @@ typedef struct _zend_async_context_s zend_async_context_t;
 typedef struct _zend_async_waker_s zend_async_waker_t;
 typedef struct _zend_async_microtask_s zend_async_microtask_t;
 typedef struct _zend_async_scope_s zend_async_scope_t;
+typedef struct _zend_async_iterator_s zend_async_iterator_t;
 typedef struct _zend_fcall_s zend_fcall_t;
 typedef void (*zend_coroutine_entry_t)(void);
 
@@ -291,6 +292,28 @@ struct _zend_async_microtask_s {
 	uint32_t ref_count;
 };
 
+///////////////////////////////////////////////////////////////////
+/// Async iterator structures
+///////////////////////////////////////////////////////////////////
+
+struct _zend_async_iterator_s {
+	zend_async_microtask_t microtask;
+	void (*run)(zend_async_iterator_t *iterator);
+	void (*run_in_coroutine)(zend_async_iterator_t *iterator, int32_t priority);
+};
+
+typedef zend_result (*zend_async_iterator_handler_t)(zend_async_iterator_t *iterator, zval *current, zval *key);
+
+typedef zend_async_iterator_t* (*zend_async_new_iterator_t)(
+	zval *array,
+	zend_object_iterator *zend_iterator,
+	zend_fcall_t *fcall,
+	zend_async_iterator_handler_t handler,
+	unsigned int concurrency,
+	int32_t priority,
+	size_t iterator_size
+);
+
 ///////////////////////////////////////////////////////////////////
 /// Event Structures
 ///////////////////////////////////////////////////////////////////
@@ -1065,6 +1088,9 @@ ZEND_API extern zend_async_add_microtask_t zend_async_add_microtask_fn;
 ZEND_API extern zend_async_get_awaiting_info_t zend_async_get_awaiting_info_fn;
 ZEND_API extern zend_async_get_class_ce_t zend_async_get_class_ce_fn;
 
+/* Iterator API */
+ZEND_API extern zend_async_new_iterator_t zend_async_new_iterator_fn;
+
 /* Context API */
 ZEND_API extern zend_async_new_context_t zend_async_new_context_fn;
 
@@ -1132,7 +1158,8 @@ ZEND_API bool zend_async_scheduler_register(
     zend_async_get_coroutines_t get_coroutines_fn,
     zend_async_add_microtask_t add_microtask_fn,
     zend_async_get_awaiting_info_t get_awaiting_info_fn,
-    zend_async_get_class_ce_t get_class_ce_fn
+    zend_async_get_class_ce_t get_class_ce_fn,
+    zend_async_new_iterator_t new_iterator_fn
 );
 
 ZEND_API bool zend_async_reactor_register(
@@ -1314,6 +1341,12 @@ END_EXTERN_C()
 #define ZEND_ASYNC_SOCKET_LISTEN_EX(host, port, backlog, extra_size) \
 	zend_async_socket_listen_fn(host, port, backlog, extra_size)
 
+/* Iterator API Macros */
+#define ZEND_ASYNC_NEW_ITERATOR(array, zend_iterator, fcall, handler, concurrency, priority) \
+	zend_async_new_iterator_fn(array, zend_iterator, fcall, handler, concurrency, priority, 0)
+#define ZEND_ASYNC_NEW_ITERATOR_EX(array, zend_iterator, fcall, handler, concurrency, priority, size) \
+	zend_async_new_iterator_fn(array, zend_iterator, fcall, handler, concurrency, priority, size)
+
 /* Context API Macros */
 #define ZEND_ASYNC_NEW_CONTEXT(parent) zend_async_new_context_fn(parent)
 #define ZEND_ASYNC_CURRENT_CONTEXT (ZEND_ASYNC_G(coroutine) != NULL ? ZEND_ASYNC_G(coroutine)->scope->context : NULL)