php-async/iterator.h at main · true-async/php-async · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
+----------------------------------------------------------------------+
  | Copyright (c) The PHP Group                                          |
  +----------------------------------------------------------------------+
  | This source file is subject to version 3.01 of the PHP license,      |
  | that is bundled with this package in the file LICENSE, and is        |
  | available through the world-wide-web at the following url:           |
  | https://www.php.net/license/3_01.txt                                 |
  | If you did not receive a copy of the PHP license and are unable to   |
  | obtain it through the world-wide-web, please send a note to          |
  | license@php.net so we can mail you a copy immediately.               |
  +----------------------------------------------------------------------+
  | Author: Edmond                                                       |
  +----------------------------------------------------------------------+
*/
#ifndef ITERATOR_H
#define ITERATOR_H

#include <Zend/zend_async_API.h>

typedef struct _async_iterator_t async_iterator_t;

typedef void (*async_iterator_spawn_next_t)(async_iterator_t *iterator);
typedef void (*async_iterator_dtor_t)(async_iterator_t *iterator);
typedef zend_result (*async_iterator_handler_t)(async_iterator_t *iterator, zval *current, zval *key);

typedef enum
{
	ASYNC_ITERATOR_INIT = 0,
	ASYNC_ITERATOR_MOVING,
	ASYNC_ITERATOR_STARTED,
	ASYNC_ITERATOR_FINISHED,
} async_iterator_state_t;

async_iterator_t *async_iterator_new(zval *array,
									 zend_object_iterator *zend_iterator,
									 zend_fcall_t *fcall,
									 async_iterator_handler_t handler,
									 zend_async_scope_t *scope,
									 unsigned int concurrency,
									 int32_t priority,
									 size_t iterator_size);

#define ASYNC_ITERATOR_DTOR zend_async_iterator_method_t

void async_iterator_run(async_iterator_t *iterator);
void async_iterator_run_in_coroutine(async_iterator_t *iterator, int32_t priority, bool throw_exception);
void async_iterator_apply_exception(async_iterator_t *iterator);
zend_async_event_t *async_iterator_completion_event_create(void);

struct _async_iterator_t
{
	ZEND_ASYNC_ITERATOR_FIELDS
	/* The current state of the iterator. See async_iterator_state_t */
	async_iterator_state_t state;
	/* The number of active coroutines that are currently executing */
	unsigned int active_coroutines;
	/* The internal handler */
	async_iterator_handler_t handler;
	/* Callback and info / cache to be used when coroutine is started. */
	zend_fcall_t *fcall;
	/* An array. */
	zval array;
	HashTable *target_hash;
	HashPosition position;
	uint32_t hash_iterator;
	/* The iterator object, which may be NULL if there is no iterator. */
	zend_object_iterator *zend_iterator;
};

#endif // ITERATOR_H