danog/asyncConstruct
1
0
Fork 0
mirror of https://github.com/danog/asyncConstruct.git synced 2024-11-26 18:54:38 +01:00
Code Issues Projects Releases Wiki Activity

Update

Browse Source
This commit is contained in:
Daniil Gentili 2020-07-31 15:43:00 +02:00
parent 83b20c0dff
commit 9b114ca8b7
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -23,52 +23,52 @@ composer require danog/async-construct
### AsyncConstruct
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/AsyncConstruct.php)
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/async.php)
Simply `use` this trait in your class, and define a `__construct_async` async method.
The trait will automatically run the async method on construction, and expose a set of APIs to wait on the result of the constructor for initialization.
### init()
### `init()`
Will blockingly wait for execution of the async constructor, returning its return value.
### initAsynchronously()
### `initAsynchronously()`
Will return a promise that, when `yield`ed, will wait for and return the return value of the constructor.
### inited()
### `inited()`
Returns a boolean, indicating whether the class was initialized or not.
### BlockingConstruct
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/BlockingConstruct.php)
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/blocking.php)
Exactly like [AsyncConstruct], except that the blocking `init()` function will be automatically called on construction.
### AsyncWakeup
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/AsyncWakeup.php)
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/asyncWakeup.php)
Simply `use` this trait in your class, and define a `__wakeup_async` async method.
The trait will automatically run the async method on deserialization, and expose a set of APIs to wait on the result of the wakeup function for re-initialization.
### wakeup()
### `wakeup()`
Will blockingly wait for execution of the async wakeup function, returning its return value.
### wakeupAsynchronously()
### `wakeupAsynchronously()`
Will return a promise that, when `yield`ed, will wait for and return the return value of the wakeup function.
### wokenUp()
### `wokenUp()`
Returns a boolean, indicating whether the class was initialized or not.
### BlockingWakeup
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/BlockingWakeup.php)
[Example](https://github.com/danog/asyncConstruct/blob/master/examples/blockingWakeup.php)
Exactly like [AsyncWakeup](#AsyncWakeup), except that the blocking `wakeup()` function will be automatically called on wakeup.