mirror of
https://github.com/danog/ext-uv.git
synced 2024-11-26 20:14:47 +01:00
update readme [ci skip]
This commit is contained in:
parent
706ef03e74
commit
933a05f0f5
162
README.md
162
README.md
@ -281,6 +281,21 @@ uv_run();
|
||||
|
||||
### void uv_timer_again(resource $timer)
|
||||
|
||||
##### *Description*
|
||||
|
||||
restart timer.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $timer*: uv_timer resource.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*void*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
|
||||
|
||||
### void uv_timer_set_repeat(resource $timer, long $repeat)
|
||||
|
||||
@ -290,12 +305,81 @@ uv_run();
|
||||
|
||||
### void uv_idle_start(resource $idle, callable $callback)
|
||||
|
||||
##### *Description*
|
||||
|
||||
start idle callback.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $idle*: uv_idle resource.
|
||||
*callable $callback*: idle callback.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*void*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_default_loop();
|
||||
$idle = uv_idle_init();
|
||||
|
||||
$i = 0;
|
||||
uv_idle_start($idle, function($idle_handle, $stat) use (&$i){
|
||||
echo "count: {$i}" . PHP_EOL;
|
||||
$i++;
|
||||
|
||||
if ($i > 3) {
|
||||
uv_idle_stop($idle);
|
||||
}
|
||||
sleep(1);
|
||||
});
|
||||
|
||||
uv_run();
|
||||
````
|
||||
|
||||
|
||||
|
||||
### void uv_getaddrinfo(resource $loop, callable $callback, string $node, string $service, array $hints)
|
||||
|
||||
|
||||
### void uv_idle_stop(resource $idle)
|
||||
|
||||
##### *Description*
|
||||
|
||||
stop idle callback.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $idle*: uv_idle resource.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*void*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_default_loop();
|
||||
$idle = uv_idle_init();
|
||||
|
||||
$i = 0;
|
||||
uv_idle_start($idle, function($idle_handle, $stat) use (&$i){
|
||||
echo "count: {$i}" . PHP_EOL;
|
||||
$i++;
|
||||
|
||||
if ($i > 3) {
|
||||
uv_idle_stop($idle);
|
||||
}
|
||||
sleep(1);
|
||||
});
|
||||
|
||||
uv_run();
|
||||
````
|
||||
|
||||
|
||||
|
||||
### resource uv_tcp_init([resource $loop])
|
||||
|
||||
@ -322,15 +406,92 @@ $tcp = uv_tcp_init();
|
||||
|
||||
### resource uv_idle_init([resource $loop])
|
||||
|
||||
##### *Description*
|
||||
|
||||
initialize uv idle handle.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $loop*: uv_loop resource.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource $idle*: initialized idle handle.
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_default_loop();
|
||||
$idle = uv_idle_init($loop);
|
||||
````
|
||||
|
||||
|
||||
|
||||
### resource uv_default_loop()
|
||||
|
||||
##### *Description*
|
||||
|
||||
return default loop handle.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource $loop*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_default_loop();
|
||||
````
|
||||
|
||||
|
||||
|
||||
### resource uv_loop_new()
|
||||
|
||||
##### *Description*
|
||||
|
||||
create a new loop handle.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource $loop*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_loop_new();
|
||||
````
|
||||
|
||||
|
||||
|
||||
### resource uv_udp_init([resource $loop])
|
||||
|
||||
##### *Description*
|
||||
|
||||
create a udp socket.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $loop*: loop resource or null. if not specified loop resource then use uv_default_loop resource.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource php_uv*: uv resource which initialized for udp.
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$udp = uv_udp_init();
|
||||
````
|
||||
|
||||
|
||||
|
||||
### void uv_udp_bind(resource $resource, resource $address, long $flags)
|
||||
|
||||
@ -631,4 +792,3 @@ TODO:
|
||||
### bool uv_http_parser_execute(resource $parser, string $body, array &$result)
|
||||
|
||||
|
||||
|
||||
|
111
php_uv.c
111
php_uv.c
@ -3417,6 +3417,40 @@ PHP_FUNCTION(uv_getaddrinfo)
|
||||
/* }}} */
|
||||
|
||||
/* {{{ proto void uv_idle_stop(resource $idle)
|
||||
|
||||
##### *Description*
|
||||
|
||||
stop idle callback.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $idle*: uv_idle resource.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*void*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_default_loop();
|
||||
$idle = uv_idle_init();
|
||||
|
||||
$i = 0;
|
||||
uv_idle_start($idle, function($idle_handle, $stat) use (&$i){
|
||||
echo "count: {$i}" . PHP_EOL;
|
||||
$i++;
|
||||
|
||||
if ($i > 3) {
|
||||
uv_idle_stop($idle);
|
||||
}
|
||||
sleep(1);
|
||||
});
|
||||
|
||||
uv_run();
|
||||
````
|
||||
|
||||
*/
|
||||
PHP_FUNCTION(uv_idle_stop)
|
||||
{
|
||||
@ -3473,6 +3507,27 @@ PHP_FUNCTION(uv_tcp_init)
|
||||
/* }}} */
|
||||
|
||||
/* {{{ proto resource uv_idle_init([resource $loop])
|
||||
|
||||
##### *Description*
|
||||
|
||||
initialize uv idle handle.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $loop*: uv_loop resource.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource $idle*: initialized idle handle.
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_default_loop();
|
||||
$idle = uv_idle_init($loop);
|
||||
````
|
||||
|
||||
*/
|
||||
PHP_FUNCTION(uv_idle_init)
|
||||
{
|
||||
@ -3490,6 +3545,24 @@ PHP_FUNCTION(uv_idle_init)
|
||||
/* }}} */
|
||||
|
||||
/* {{{ proto resource uv_default_loop()
|
||||
|
||||
##### *Description*
|
||||
|
||||
return default loop handle.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource $loop*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_default_loop();
|
||||
````
|
||||
|
||||
*/
|
||||
PHP_FUNCTION(uv_default_loop)
|
||||
{
|
||||
@ -3498,6 +3571,24 @@ PHP_FUNCTION(uv_default_loop)
|
||||
/* }}} */
|
||||
|
||||
/* {{{ proto resource uv_loop_new()
|
||||
|
||||
##### *Description*
|
||||
|
||||
create a new loop handle.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource $loop*:
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$loop = uv_loop_new();
|
||||
````
|
||||
|
||||
*/
|
||||
PHP_FUNCTION(uv_loop_new)
|
||||
{
|
||||
@ -3510,6 +3601,26 @@ PHP_FUNCTION(uv_loop_new)
|
||||
|
||||
|
||||
/* {{{ proto resource uv_udp_init([resource $loop])
|
||||
|
||||
##### *Description*
|
||||
|
||||
create a udp socket.
|
||||
|
||||
##### *Parameters*
|
||||
|
||||
*resource $loop*: loop resource or null. if not specified loop resource then use uv_default_loop resource.
|
||||
|
||||
##### *Return Value*
|
||||
|
||||
*resource php_uv*: uv resource which initialized for udp.
|
||||
|
||||
##### *Example*
|
||||
|
||||
````php
|
||||
<?php
|
||||
$udp = uv_udp_init();
|
||||
````
|
||||
|
||||
*/
|
||||
PHP_FUNCTION(uv_udp_init)
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user