From 11582c5ec5c4b3d9fd59fa1e441afac8d8d02e2e Mon Sep 17 00:00:00 2001 From: Gina Peter Banyard Date: Sun, 25 Jan 2026 15:46:32 +0000 Subject: [PATCH] eio: fix XML by converting para to simpara tags via script --- reference/eio/book.xml | 13 +++--- reference/eio/configure.xml | 14 +++--- reference/eio/constants.xml | 16 +++---- reference/eio/functions/eio-busy.xml | 33 ++++++-------- reference/eio/functions/eio-cancel.xml | 20 ++++----- reference/eio/functions/eio-chmod.xml | 29 +++++------- reference/eio/functions/eio-chown.xml | 36 +++++++-------- reference/eio/functions/eio-close.xml | 29 +++++------- reference/eio/functions/eio-custom.xml | 19 ++++---- reference/eio/functions/eio-dup2.xml | 33 ++++++-------- reference/eio/functions/eio-event-loop.xml | 14 +++--- reference/eio/functions/eio-fallocate.xml | 45 +++++++++---------- reference/eio/functions/eio-fchmod.xml | 33 ++++++-------- reference/eio/functions/eio-fchown.xml | 39 +++++++--------- reference/eio/functions/eio-fdatasync.xml | 29 +++++------- reference/eio/functions/eio-fstat.xml | 20 ++++----- reference/eio/functions/eio-fstatvfs.xml | 20 ++++----- reference/eio/functions/eio-fsync.xml | 29 +++++------- reference/eio/functions/eio-ftruncate.xml | 33 ++++++-------- reference/eio/functions/eio-futime.xml | 37 +++++++-------- .../eio/functions/eio-get-event-stream.xml | 16 +++---- .../eio/functions/eio-get-last-error.xml | 16 +++---- reference/eio/functions/eio-grp-add.xml | 20 ++++----- reference/eio/functions/eio-grp-cancel.xml | 16 +++---- reference/eio/functions/eio-grp-limit.xml | 20 ++++----- reference/eio/functions/eio-grp.xml | 19 ++++---- reference/eio/functions/eio-init.xml | 18 ++++---- reference/eio/functions/eio-link.xml | 33 ++++++-------- reference/eio/functions/eio-lstat.xml | 23 +++++----- reference/eio/functions/eio-mkdir.xml | 33 ++++++-------- reference/eio/functions/eio-mknod.xml | 37 +++++++-------- reference/eio/functions/eio-nop.xml | 25 +++++------ reference/eio/functions/eio-npending.xml | 14 +++--- reference/eio/functions/eio-nready.xml | 14 +++--- reference/eio/functions/eio-nreqs.xml | 14 +++--- reference/eio/functions/eio-nthreads.xml | 14 +++--- reference/eio/functions/eio-open.xml | 30 ++++++------- reference/eio/functions/eio-poll.xml | 16 +++---- reference/eio/functions/eio-read.xml | 31 ++++++------- reference/eio/functions/eio-readahead.xml | 37 +++++++-------- reference/eio/functions/eio-readdir.xml | 20 ++++----- reference/eio/functions/eio-readlink.xml | 23 +++++----- reference/eio/functions/eio-realpath.xml | 31 ++++++------- reference/eio/functions/eio-rename.xml | 33 ++++++-------- reference/eio/functions/eio-rmdir.xml | 29 +++++------- reference/eio/functions/eio-seek.xml | 35 +++++++-------- reference/eio/functions/eio-sendfile.xml | 32 +++++++------ reference/eio/functions/eio-set-max-idle.xml | 16 +++---- .../eio/functions/eio-set-max-parallel.xml | 16 +++---- .../eio/functions/eio-set-max-poll-reqs.xml | 16 +++---- .../eio/functions/eio-set-max-poll-time.xml | 16 +++---- .../eio/functions/eio-set-min-parallel.xml | 16 +++---- reference/eio/functions/eio-stat.xml | 23 +++++----- reference/eio/functions/eio-statvfs.xml | 22 +++++---- reference/eio/functions/eio-symlink.xml | 33 ++++++-------- .../eio/functions/eio-sync-file-range.xml | 41 ++++++++--------- reference/eio/functions/eio-sync.xml | 12 +++-- reference/eio/functions/eio-syncfs.xml | 29 +++++------- reference/eio/functions/eio-truncate.xml | 33 ++++++-------- reference/eio/functions/eio-unlink.xml | 29 +++++------- reference/eio/functions/eio-utime.xml | 37 +++++++-------- reference/eio/functions/eio-write.xml | 41 ++++++++--------- reference/eio/setup.xml | 12 +++-- 63 files changed, 683 insertions(+), 899 deletions(-) diff --git a/reference/eio/book.xml b/reference/eio/book.xml index 1172df96a776..ffc65b3ba9c8 100644 --- a/reference/eio/book.xml +++ b/reference/eio/book.xml @@ -1,18 +1,16 @@ - - + Eio Eio &reftitle.intro; - - This extension provides asyncronous POSIX I/O by means of libeio C + + This extension provides asyncronous POSIX I/O by means of libeio C library written by Marc Lehmann. - + ¬e.no-windows.extension; @@ -141,7 +139,7 @@ eio_mkdir("/tmp/abc-eio-temp", 0750, EIO_PRI_DEFAULT, "my_res_cb", "mkdir data") // set event flags event_set($event, $fd, EV_READ /*| EV_PERSIST*/, "my_eio_poll", array($event, $base)); -// set event base +// set event base event_base_set($event, $base); // enable event @@ -164,7 +162,6 @@ event_base_loop($base); &reference.eio.reference; - - -
+
&reftitle.install; - - + + &pecl.info; &url.pecl.package;eio. - - + + For information about manual installation, please read the file INSTALL included in the package. - +
- - - + &reftitle.constants; &extension.constants; @@ -638,27 +637,26 @@ - + EIO_S_I* constants have the same meaning as their S_I* POSIX counterparts. - + - + EIO_SYNC_FILE_* constants have the same meaning as their SYNC_FILE_** counterparts. - + - + EIO_O_* constants have the same meaning as their O_* POSIX counterparts. - + - - - + eio_busy Artificially increase load. Could be useful in tests, @@ -13,18 +12,15 @@ resourceeio_busy intdelay - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_busy artificially increases load taking delay seconds to execute. May be used for debugging, or benchmarking. - + @@ -33,9 +29,9 @@ delay - + Delay in seconds - + @@ -47,17 +43,17 @@ callback - + This callback is called when all the group requests are done. - + data - + Arbitrary variable passed to callback. - + @@ -65,9 +61,9 @@ &reftitle.returnvalues; - + eio_busy returns request resource on success,&return.falseforfailure;. - + &reftitle.seealso; @@ -77,7 +73,6 @@ - - - + eio_cancel Cancels a request @@ -13,10 +12,10 @@ voideio_cancel resourcereq - + eio_cancel cancels a request specified by req - + @@ -25,9 +24,9 @@ req - + The request resource - + @@ -45,9 +44,9 @@ data - + Arbitrary variable passed to callback. - + @@ -55,9 +54,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -104,7 +103,6 @@ my_nop 2 - - - + eio_chmod Change file/directory permissions @@ -13,17 +12,14 @@ resourceeio_chmod stringpath intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_chmod changes file, or directory permissions. The new permissions are specified by mode. - + @@ -42,9 +38,9 @@ mode - + The new permissions. E.g. 0644. - + @@ -62,9 +58,9 @@ data - + Arbitrary variable passed to callback. - + @@ -72,9 +68,9 @@ &reftitle.returnvalues; - + eio_chmod returns request resource on success,&return.falseforfailure;. - + @@ -85,7 +81,6 @@ - - - + eio_chown Change file/directory permissions @@ -13,18 +12,14 @@ resourceeio_chown stringpath intuid - intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intgid-1 + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + Changes file, or directory permissions. - + @@ -42,17 +37,17 @@ uid - + User ID. Is ignored when equal to -1. - + gid - + Group ID. Is ignored when equal to -1. - + @@ -70,9 +65,9 @@ data - + Arbitrary variable passed to callback. - + @@ -80,9 +75,9 @@ &reftitle.returnvalues; - + eio_chown returns request resource on success,&return.falseforfailure;. - + @@ -94,7 +89,6 @@ - - - + eio_close Close file @@ -12,17 +11,14 @@ resourceeio_close mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_close closes file specified by fd. - + @@ -32,9 +28,9 @@ fd - + Stream, Socket resource, or numeric file descriptor - + @@ -52,9 +48,9 @@ data - + Arbitrary variable passed to callback. - + @@ -62,9 +58,9 @@ &reftitle.returnvalues; - + eio_close returns request resource on success,&return.falseforfailure;. - + @@ -75,7 +71,6 @@ - - - + eio_custom Execute custom request like any other eio_* call @@ -14,13 +13,12 @@ callableexecute intpri callablecallback - mixeddataNULL + mixeddataNULL - + eio_custom executes custom function specified by execute processing it just like any other eio_* call. - + @@ -65,9 +63,9 @@ data - + Arbitrary variable passed to callback. - + @@ -75,9 +73,9 @@ &reftitle.returnvalues; - + eio_custom returns request resource on success,&return.falseforfailure;. - + @@ -131,7 +129,6 @@ int(1001) - - - + eio_dup2 Duplicate a file descriptor @@ -13,17 +12,14 @@ resourceeio_dup2 mixedfd mixedfd2 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_dup2 duplicates file descriptor. - + @@ -33,17 +29,17 @@ fd - + Source stream, Socket resource, or numeric file descriptor - + fd2 - + Target stream, Socket resource, or numeric file descriptor - + @@ -61,9 +57,9 @@ data - + Arbitrary variable passed to callback. - + @@ -71,13 +67,12 @@ &reftitle.returnvalues; - + eio_dup2 returns request resource on success,&return.falseforfailure;. - + - - - + eio_event_loop Polls libeio until all requests proceeded @@ -11,11 +10,11 @@ &reftitle.description; booleio_event_loop - + - + eio_event_loop polls libeio until all requests proceeded. - + @@ -26,9 +25,9 @@ &reftitle.returnvalues; - + eio_event_loop returns &true; on success,&return.falseforfailure;. - + @@ -76,7 +75,6 @@ eio_chmod_ok - - - + eio_fallocate Allows the caller to directly manipulate the allocated disk @@ -16,28 +15,25 @@ intmode intoffset intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_fallocate allows the caller to directly manipulate the allocated disk space for the file specified by fd file descriptor for the byte range starting at offset and continuing for length bytes. - + File should be opened for writing - EIO_O_CREAT should be logically + EIO_O_CREAT should be logically OR'd with EIO_O_WRONLY, or EIO_O_RDWR - + @@ -48,34 +44,34 @@ fd - + Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open. - + mode - Currently only one flag is supported for mode: + Currently only one flag is supported for mode: EIO_FALLOC_FL_KEEP_SIZE (the same as POSIX constant FALLOC_FL_KEEP_SIZE). - + offset - + Specifies start of the byte range. - + length - + Specifies length the byte range. - + @@ -93,9 +89,9 @@ data - + Arbitrary variable passed to callback. - + @@ -103,13 +99,12 @@ &reftitle.returnvalues; - + eio_fallocate returns request resource on success,&return.falseforfailure;. - + - - - + eio_fchmod Change file permissions @@ -13,17 +12,14 @@ resourceeio_fchmod mixedfd intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_fchmod changes permissions for the file specified by fd file descriptor. - + @@ -33,17 +29,17 @@ fd - + Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open. - + mode - + The new permissions. E.g. 0644. - + @@ -61,9 +57,9 @@ data - + Arbitrary variable passed to callback. - + @@ -71,9 +67,9 @@ &reftitle.returnvalues; - + eio_fchmod returns request resource on success,&return.falseforfailure;. - + @@ -84,7 +80,6 @@ - - - + eio_fchown Change file ownership @@ -14,17 +13,14 @@ mixedfd intuid intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_fchown changes ownership of the file specified by fd file descriptor. - + @@ -34,25 +30,25 @@ fd - + Stream, Socket resource, or numeric file descriptor. - + uid - + User ID. Is ignored when equal to -1. - + gid - + Group ID. Is ignored when equal to -1. - + @@ -70,9 +66,9 @@ data - + Arbitrary variable passed to callback. - + @@ -80,11 +76,11 @@ &reftitle.returnvalues; - + eio_chmod returns request resource on success,&return.falseforfailure;. - + - + &reftitle.seealso; @@ -93,7 +89,6 @@ - - - + eio_fdatasync Synchronize a file's in-core state with storage device @@ -12,16 +11,13 @@ resourceeio_fdatasync mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_fdatasync synchronizes a file's in-core state with storage device. - + @@ -31,9 +27,9 @@ fd - + Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open. - + @@ -51,9 +47,9 @@ data - + Arbitrary variable passed to callback. - + @@ -61,13 +57,12 @@ &reftitle.returnvalues; - + eio_fdatasync returns request resource on success,&return.falseforfailure;. - + - - - + eio_fstat Get file status @@ -16,10 +15,10 @@ callablecallback mixeddata - + eio_fstat returns file status information in result argument of callback - + @@ -29,9 +28,9 @@ fd - + Stream, Socket resource, or numeric file descriptor. - + @@ -49,9 +48,9 @@ data - + Arbitrary variable passed to callback. - + @@ -59,9 +58,9 @@ &reftitle.returnvalues; - + eio_busy returns request resource on success,&return.falseforfailure;. - + @@ -153,7 +152,6 @@ array(12) { - - - + eio_fstatvfs Get file system statistics @@ -16,10 +15,10 @@ callablecallback mixeddata - + eio_fstatvfs returns file system statistics in result of callback. - + @@ -29,9 +28,9 @@ fd - + A file descriptor of a file within the mounted file system. - + @@ -49,9 +48,9 @@ data - + Arbitrary variable passed to callback. - + @@ -59,9 +58,9 @@ &reftitle.returnvalues; - + eio_fstatvfs returns request resource on success,&return.falseforfailure;. - + @@ -72,7 +71,6 @@ - - - + eio_fsync Synchronize a file's in-core state with storage device @@ -12,16 +11,13 @@ resourceeio_fsync mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + Synchronize a file's in-core state with storage device - + @@ -31,9 +27,9 @@ fd - + Stream, Socket resource, or numeric file descriptor. - + @@ -51,9 +47,9 @@ data - + Arbitrary variable passed to callback. - + @@ -61,9 +57,9 @@ &reftitle.returnvalues; - + eio_fsync returns request resource on success,&return.falseforfailure;. - + @@ -75,7 +71,6 @@ - - - + eio_ftruncate Truncate a file @@ -13,18 +12,15 @@ resourceeio_ftruncate mixedfd intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_ftruncate causes a regular file referenced by fd file descriptor to be truncated to precisely length bytes. - + @@ -34,17 +30,17 @@ fd - + Stream, Socket resource, or numeric file descriptor. - + offset - + Offset from beginning of the file - + @@ -62,9 +58,9 @@ data - + Arbitrary variable passed to callback. - + @@ -72,9 +68,9 @@ &reftitle.returnvalues; - + eio_ftruncate returns request resource on success,&return.falseforfailure;. - + @@ -86,7 +82,6 @@ - - - + eio_futime Change file last access and modification times @@ -14,18 +13,15 @@ mixedfd floatatime floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_futime changes file last access and modification times. - + @@ -35,25 +31,25 @@ fd - + Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open - + atime - + Access time - + mtime - + Modification time - + @@ -71,9 +67,9 @@ data - + Arbitrary variable passed to callback. - + @@ -81,9 +77,9 @@ &reftitle.returnvalues; - + eio_futime returns request resource on success,&return.falseforfailure;. - + @@ -94,7 +90,6 @@ - - - + eio_get_event_stream Get stream representing a variable used in internal communications with libeio @@ -11,14 +10,14 @@ &reftitle.description; mixedeio_get_event_stream - + - + eio_get_event_stream acquires stream representing a variable used in internal communications with libeio. Could be used to bind with some event loop provided by other PECL extension, for example libevent. - + @@ -28,10 +27,10 @@ &reftitle.returnvalues; - + eio_get_event_stream returns stream on success; otherwise, &null; - + @@ -67,7 +66,7 @@ eio_mkdir("/tmp/abc-eio-temp", 0750, EIO_PRI_DEFAULT, "my_res_cb", "mkdir data") // set event flags event_set($event, $fd, EV_READ /*| EV_PERSIST*/, "my_eio_poll", array($event, $base)); -// set event base +// set event base event_base_set($event, $base); // enable event @@ -95,7 +94,6 @@ string(10) "mkdir data" - - - + eio_get_last_error Returns string describing the last error associated with a request resource @@ -13,9 +12,9 @@ stringeio_get_last_error resourcereq - + eio_get_last_error returns string describing the last error associated with req. - + @@ -24,9 +23,9 @@ req - + The request resource. - + @@ -34,13 +33,12 @@ &reftitle.returnvalues; - + eio_get_last_error returns string describing the last error associated with the request resource specified by req. - + &warn.experimental.func; - - - + eio_grp_add Adds a request to the request group @@ -14,9 +13,9 @@ resourcegrp resourcereq - + eio_grp_add adds a request to the request group. - + @@ -26,17 +25,17 @@ grp - + The request group resource returned by eio_grp - + req - + The request resource - + @@ -44,9 +43,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -131,7 +130,6 @@ bool(true) - - - + eio_grp_cancel Cancels a request group @@ -13,10 +12,10 @@ voideio_grp_cancel resourcegrp - + eio_grp_cancel cancels a group request specified by grp request group resource. - + @@ -26,9 +25,9 @@ grp - + The request group resource returned by eio_grp. - + @@ -36,9 +35,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -50,7 +49,6 @@ - - - + eio_grp_limit Set group limit @@ -14,9 +13,9 @@ resourcegrp intlimit - + Limit number of requests in the request group. - + @@ -26,17 +25,17 @@ grp - + The request group resource. - + limit - + Number of requests in the group. - + @@ -44,9 +43,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -57,7 +56,6 @@ - - - + eio_grp Creates a request group @@ -12,12 +11,11 @@ resourceeio_grp callablecallback - stringdataNULL + stringdataNULL - + eio_grp creates a request group. - + @@ -33,9 +31,9 @@ data - + Arbitrary variable passed to callback. - + @@ -43,9 +41,9 @@ &reftitle.returnvalues; - + eio_grp returns request group resource on success,&return.falseforfailure;. - + @@ -124,7 +122,6 @@ string(4) "some" - - - + eio_init (Re-)initialize Eio @@ -11,15 +10,15 @@ &reftitle.description; voideio_init - + - + eio_init (re-)initializes Eio. It allocates memory for internal structures of libeio and Eio itself. You may call eio_init before using Eio functions. Otherwise it will be called internally first time you invoke an Eio function in a process. - + - + This function was removed in version 3.0.0RC1 of the eio extension for PHP version 8 and higher. - + @@ -30,12 +29,11 @@ &reftitle.returnvalues; - + &return.void; - + - - - + eio_link Create a hardlink for file @@ -13,18 +12,15 @@ resourceeio_link stringpath stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_link creates a hardlink new_path for a file specified by path. - + @@ -34,17 +30,17 @@ path - + Source file path. - + new_path - + Target file path. - + @@ -62,9 +58,9 @@ data - + Arbitrary variable passed to callback. - + @@ -72,9 +68,9 @@ &reftitle.returnvalues; - + - + @@ -140,7 +136,6 @@ string(%d) "%ssymlink.dat" - - - + eio_lstat Get file status @@ -14,13 +13,12 @@ stringpath intpri callablecallback - mixeddataNULL + mixeddataNULL - + eio_lstat returns file status information in result argument of callback - + @@ -30,9 +28,9 @@ path - + The file path - + @@ -50,9 +48,9 @@ data - + Arbitrary variable passed to callback. - + @@ -60,9 +58,9 @@ &reftitle.returnvalues; - + eio_lstat returns request resource on success or &false; on error. - + @@ -139,7 +137,6 @@ array(12) { - - - + eio_mkdir Create directory @@ -13,17 +12,14 @@ resourceeio_mkdir stringpath intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_mkdir creates directory with specified access mode. - + @@ -33,17 +29,17 @@ path - + Path for the new directory. - + mode - + Access mode, e.g. 0755 - + @@ -61,9 +57,9 @@ data - + Arbitrary variable passed to callback. - + @@ -71,9 +67,9 @@ &reftitle.returnvalues; - + eio_mkdir returns request resource on success,&return.falseforfailure;. - + @@ -122,7 +118,6 @@ eio_mkdir_ok - - - + eio_mknod Create a special or ordinary file @@ -14,17 +13,14 @@ stringpath intmode intdev - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_mknod creates ordinary or special(often) file. - + &warn.undocumented.func; @@ -36,15 +32,15 @@ path - + Path for the new node(file). - + mode - + Specifies both the permissions to use and the type of node to be created. It should be a combination (using bitwise OR) of one of the file types listed below and the permissions for the new node(e.g. 0640). @@ -57,19 +53,19 @@ To specify permissions EIO_S_I* constants could be used. - + dev - + If the file type is EIO_S_IFCHR or EIO_S_IFBLK then dev specifies the major and minor numbers of the newly created device special file. Otherwise dev ignored. See mknod(2) man page for details. - + @@ -87,9 +83,9 @@ data - + Arbitrary variable passed to callback. - + @@ -97,9 +93,9 @@ &reftitle.returnvalues; - + eio_mknod returns request resource on success,&return.falseforfailure;. - + @@ -202,7 +198,6 @@ eio_mknod_ok - - - + eio_nop Does nothing, except go through the whole request cycle @@ -11,17 +10,14 @@ &reftitle.description; resourceeio_nop - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_nop does nothing, except go through the whole request cycle. Could be useful in debugging. - + @@ -43,9 +39,9 @@ data - + Arbitrary variable passed to callback. - + @@ -53,9 +49,9 @@ &reftitle.returnvalues; - + eio_nop returns request resource on success,&return.falseforfailure;. - + @@ -67,7 +63,6 @@ - - - + eio_npending Returns number of finished, but unhandled requests @@ -11,11 +10,11 @@ &reftitle.description; inteio_npending - + - + eio_npending returns number of finished, but unhandled requests - + @@ -26,10 +25,10 @@ &reftitle.returnvalues; - + eio_npending returns number of finished, but unhandled requests. - + @@ -43,7 +42,6 @@ - - - + eio_nready Returns number of not-yet handled requests @@ -11,11 +10,11 @@ &reftitle.description; inteio_nready - + - + - + @@ -26,9 +25,9 @@ &reftitle.returnvalues; - + eio_nready returns number of not-yet handled requests - + @@ -42,7 +41,6 @@ - - - + eio_nreqs Returns number of requests to be processed @@ -11,12 +10,12 @@ &reftitle.description; inteio_nreqs - + - + eio_nreqs could be called in a custom loop calling eio_poll. - + @@ -27,9 +26,9 @@ &reftitle.returnvalues; - + eio_nreqs returns number of requests to be processed. - + @@ -78,7 +77,6 @@ int(0) - - - + eio_nthreads Returns number of threads currently in use @@ -11,11 +10,11 @@ &reftitle.description; inteio_nthreads - + - + - + @@ -26,10 +25,10 @@ &reftitle.returnvalues; - + eio_nthreads returns number of threads currently in use. - + @@ -46,7 +45,6 @@ - - - + eio_open Opens a file @@ -16,13 +15,12 @@ intmode intpri callablecallback - mixeddataNULL + mixeddataNULL - + eio_open opens file specified by path in access mode mode with - + @@ -45,23 +43,22 @@ flags - One of EIO_O_* constants, or their + One of EIO_O_* constants, or their combinations. EIO_O_* constants have the same meaning, as their corresponding O_* counterparts defined in fnctl.h C header file. Default is EIO_O_RDWR. - + mode - One of EIO_S_I* constants, or their combination + One of EIO_S_I* constants, or their combination (via bitwise OR operator). The constants have the same meaning as their - S_I* counterparts defined in sys/stat.h + S_I* counterparts defined in sys/stat.h C header file. Required, if a file is created. Otherwise ignored. - + @@ -79,9 +76,9 @@ data - + Arbitrary variable passed to callback. - + @@ -89,11 +86,11 @@ &reftitle.returnvalues; - + eio_open returns file descriptor in result argument of callback on success; otherwise, result is equal to -1. - + @@ -151,7 +148,6 @@ bool(true) - - - + eio_poll Can be to be called whenever there are pending requests that need finishing @@ -11,15 +10,15 @@ &reftitle.description; inteio_poll - + - + eio_poll can be used to implement special event loop. For this eio_nreqs could be used to test if there are unprocessed requests. - + - Applicable only when implementing userspace event loop. + Applicable only when implementing userspace event loop. @@ -30,10 +29,10 @@ &reftitle.returnvalues; - + If any request invocation returns a non-zero value, returns that value. Otherwise, it returns 0. - + @@ -81,7 +80,6 @@ int(0) - - - + eio_read Read from a file descriptor at given offset @@ -16,15 +15,14 @@ intoffset intpri callablecallback - mixeddataNULL + mixeddataNULL - + eio_read reads up to length bytes from fd file descriptor at offset. The read bytes are stored in result argument of callback. - + @@ -34,25 +32,25 @@ fd - + Stream, Socket resource, or numeric file descriptor - + length - + Maximum number of bytes to read. - + offset - + Offset within the file. - + @@ -70,9 +68,9 @@ data - + Arbitrary variable passed to callback. - + @@ -80,11 +78,11 @@ &reftitle.returnvalues; - + eio_read stores read bytes in result argument of callback function. - + @@ -156,7 +154,6 @@ string(5) "34567" - - - + eio_readahead Perform file readahead into page cache @@ -14,17 +13,14 @@ mixedfd intoffset intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_readahead populates the page cache with data from a file so that subsequent reads from that file will not block on disk I/O. See READAHEAD(2) man page for details. - + @@ -34,25 +30,25 @@ fd - + Stream, Socket resource, or numeric file descriptor - + offset - + Starting point from which data is to be read. - + length - + Number of bytes to be read. - + @@ -70,9 +66,9 @@ data - + Arbitrary variable passed to callback. - + @@ -80,13 +76,12 @@ &reftitle.returnvalues; - + eio_readahead returns request resource on success,&return.falseforfailure;. - + - - - + eio_readlink Read value of a symbolic link @@ -14,12 +13,11 @@ stringpath intpri callablecallback - mixeddataNULL + mixeddataNULL - + - + @@ -29,9 +27,9 @@ path - + Source symbolic link path - + @@ -49,9 +47,9 @@ data - + Arbitrary variable passed to callback. - + @@ -59,9 +57,9 @@ &reftitle.returnvalues; - + eio_readlink returns request resource on success,&return.falseforfailure;. - + @@ -127,7 +125,6 @@ string(16) "/tmp/symlink.dat" - - - + eio_realpath Get the canonicalized absolute pathname @@ -14,14 +13,13 @@ stringpath intpri callablecallback - stringdataNULL + stringdataNULL - + eio_realpath returns the canonicalized absolute pathname in result argument of callback function. - + @@ -31,34 +29,34 @@ path - + Short pathname - + pri - + - + callback - + - + data - + - + @@ -66,9 +64,9 @@ &reftitle.returnvalues; - + - + @@ -100,7 +98,6 @@ string(5) "/home" - - - + eio_rename Change the name or location of a file @@ -13,16 +12,13 @@ resourceeio_rename stringpath stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_rename renames or moves a file to new location. - + @@ -32,17 +28,17 @@ path - + Source path - + new_path - + Target path - + @@ -60,9 +56,9 @@ data - + Arbitrary variable passed to callback. - + @@ -70,9 +66,9 @@ &reftitle.returnvalues; - + eio_rename returns request resource on success,&return.falseforfailure;. - + @@ -112,7 +108,6 @@ eio_rename_ok - - - + eio_rmdir Remove a directory @@ -12,16 +11,13 @@ resourceeio_rmdir stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_rmdir removes a directory. - + @@ -31,9 +27,9 @@ path - + Directory path - + @@ -51,9 +47,9 @@ data - + Arbitrary variable passed to callback. - + @@ -61,9 +57,9 @@ &reftitle.returnvalues; - + eio_rmdir returns request resource on success,&return.falseforfailure;. - + @@ -108,7 +104,6 @@ eio_rmdir_ok - - - + eio_seek Seek to a position @@ -14,19 +13,16 @@ mixedfd intoffset intwhence - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - - eio_seek repositions the offset of the open file associated with + + eio_seek repositions the offset of the open file associated with stream, Socket instance, or file descriptor specified by fd to the argument offset according to the directive whence. - + @@ -35,17 +31,17 @@ fd - + Stream, Socket instance, or numeric file descriptor. - + offset - + Starting point from which data is to be read. - + @@ -76,9 +72,9 @@ data - + Arbitrary variable passed to callback. - + @@ -86,13 +82,12 @@ &reftitle.returnvalues; - + eio_seek returns request resource on success,&return.falseforfailure;. - + - - - + eio_sendfile Transfer data between file descriptors @@ -19,10 +18,10 @@ callablecallback stringdata - + eio_sendfile copies data between one file descriptor and another. See SENDFILE(2) man page for details. - + @@ -32,33 +31,33 @@ out_fd - + Output stream, Socket resource, or file descriptor. Should be opened for writing. - + in_fd - + Input stream, Socket resource, or file descriptor. Should be opened for reading. - + offset - + Offset within the source file. - + length - + Number of bytes to copy. - + @@ -76,9 +75,9 @@ data - + Arbitrary variable passed to callback. - + @@ -86,13 +85,12 @@ &reftitle.returnvalues; - + eio_sendfile returns request resource on success,&return.falseforfailure;. - + - - - + eio_set_max_idle Set maximum number of idle threads @@ -13,9 +12,9 @@ voideio_set_max_idle intnthreads - + - + @@ -25,9 +24,9 @@ nthreads - + Number of idle threads. - + @@ -35,9 +34,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -50,7 +49,6 @@ - - - + eio_set_max_parallel Set maximum parallel threads @@ -13,9 +12,9 @@ voideio_set_max_parallel intnthreads - + - + @@ -25,9 +24,9 @@ nthreads - + Number of parallel threads - + @@ -35,9 +34,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -50,7 +49,6 @@ - - - + eio_set_max_poll_reqs Set maximum number of requests processed in a poll @@ -13,9 +12,9 @@ voideio_set_max_poll_reqs intnreqs - + - + @@ -25,9 +24,9 @@ nreqs - + Number of requests - + @@ -35,13 +34,12 @@ &reftitle.returnvalues; - + &return.void; - + - - - + eio_set_max_poll_time Set maximum poll time @@ -13,10 +12,10 @@ voideio_set_max_poll_time floatnseconds - + Polling stops, if poll took longer than nseconds seconds. - + @@ -26,9 +25,9 @@ nseconds - + Number of seconds - + @@ -36,13 +35,12 @@ &reftitle.returnvalues; - + &return.void; - + - - - + eio_set_min_parallel Set minimum parallel thread number @@ -13,9 +12,9 @@ voideio_set_min_parallel stringnthreads - + - + @@ -25,9 +24,9 @@ nthreads - + Number of parallel threads. - + @@ -35,9 +34,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -51,7 +50,6 @@ - - - + eio_stat Get file status @@ -14,13 +13,12 @@ stringpath intpri callablecallback - mixeddataNULL + mixeddataNULL - + eio_stat returns file status information in result argument of callback - + @@ -30,9 +28,9 @@ path - + The file path - + @@ -50,9 +48,9 @@ data - + Arbitrary variable passed to callback. - + @@ -60,11 +58,11 @@ &reftitle.returnvalues; - + eio_stat returns request resource on success or &false; on error. On success assigns result argument of callback to an array. - + @@ -141,7 +139,6 @@ array(12) { - - - + eio_statvfs Get file system statistics @@ -16,10 +15,10 @@ callablecallback mixeddata - + eio_statvfs returns file system statistics information in result argument of callback - + @@ -28,9 +27,9 @@ path - + Pathname of any file within the mounted file system - + @@ -48,9 +47,9 @@ data - + Arbitrary variable passed to callback. - + @@ -58,11 +57,11 @@ &reftitle.returnvalues; - - eio_statvfs returns request resource on success,&return.falseforfailure;. + + eio_statvfs returns request resource on success,&return.falseforfailure;. On success assigns result argument of callback to an array. - + @@ -122,7 +121,6 @@ array(11) { - - - + eio_symlink Create a symbolic link @@ -13,18 +12,15 @@ resourceeio_symlink stringpath stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_symlink creates a symbolic link new_path to path. - + @@ -34,17 +30,17 @@ path - + Source path - + new_path - + Target path - + @@ -62,9 +58,9 @@ data - + Arbitrary variable passed to callback. - + @@ -72,9 +68,9 @@ &reftitle.returnvalues; - + eio_symlink returns request resource on success,&return.falseforfailure;. - + @@ -130,7 +126,6 @@ string(16) "/tmp/symlink.dat" - - - + eio_sync_file_range Sync a file segment with disk @@ -15,17 +14,14 @@ intoffset intnbytes intflags - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_sync_file_range permits fine control when synchronizing the open file referred to by the file descriptor fd with disk. - + @@ -35,40 +31,40 @@ fd - + File descriptor - + offset - + The starting byte of the file range to be synchronized - + nbytes - + Specifies the length of the range to be synchronized, in bytes. If nbytes is zero, then all bytes from offset through to the end of file are synchronized. - + flags - + A bit-mask. Can include any of the following values: EIO_SYNC_FILE_RANGE_WAIT_BEFORE, EIO_SYNC_FILE_RANGE_WRITE, EIO_SYNC_FILE_RANGE_WAIT_AFTER. These flags have the same meaning as their SYNC_FILE_RANGE_* counterparts(see SYNC_FILE_RANGE(2) man page). - + @@ -86,9 +82,9 @@ data - + Arbitrary variable passed to callback. - + @@ -96,13 +92,12 @@ &reftitle.returnvalues; - + eio_sync_file_range returns request resource on success,&return.falseforfailure;. - + - - - + eio_sync Commit buffer cache to disk @@ -15,9 +14,9 @@ callablecallbackNULL mixeddataNULL - + - + @@ -28,13 +27,12 @@ &reftitle.returnvalues; - + eio_sync returns request resource on success,&return.falseforfailure;. - + - - - + eio_syncfs Calls Linux' syncfs syscall, if available @@ -12,16 +11,13 @@ resourceeio_syncfs mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + - + @@ -31,10 +27,10 @@ fd - + File descriptor - + @@ -52,9 +48,9 @@ data - + Arbitrary variable passed to callback. - + @@ -62,14 +58,13 @@ &reftitle.returnvalues; - + eio_syncfs returns request resource on success,&return.falseforfailure;. - + - - - + eio_truncate Truncate a file @@ -13,17 +12,14 @@ resourceeio_truncate stringpath intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_truncate causes the regular file named by path to be truncated to a size of precisely length bytes - + @@ -33,17 +29,17 @@ path - + File path - + offset - + Offset from beginning of the file. - + @@ -61,9 +57,9 @@ data - + Arbitrary variable passed to callback. - + @@ -71,9 +67,9 @@ &reftitle.returnvalues; - + eio_busy returns request resource on success,&return.falseforfailure;. - + @@ -84,7 +80,6 @@ - - - + eio_unlink Delete a name and possibly the file it refers to @@ -12,16 +11,13 @@ resourceeio_unlink stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_unlink deletes a name from the file system. - + @@ -31,9 +27,9 @@ path - + Path to file - + @@ -51,9 +47,9 @@ data - + Arbitrary variable passed to callback. - + @@ -61,13 +57,12 @@ &reftitle.returnvalues; - + eio_unlink returns request resource on success,&return.falseforfailure;. - + - - - + eio_utime Change file last access and modification times @@ -14,16 +13,13 @@ stringpath floatatime floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + - + @@ -33,25 +29,25 @@ path - + Path to the file. - + atime - + Access time - + mtime - + Modification time - + @@ -69,9 +65,9 @@ data - + Arbitrary variable passed to callback. - + @@ -79,9 +75,9 @@ &reftitle.returnvalues; - + eio_utime returns request resource on success,&return.falseforfailure;. - + @@ -92,7 +88,6 @@ - - - + eio_write Write to file @@ -15,18 +14,15 @@ stringstr intlength0 intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL + intpriEIO_PRI_DEFAULT + callablecallbackNULL + mixeddataNULL - + eio_write writes up to length bytes from str at offset offset from the beginning of the file. - + @@ -36,33 +32,33 @@ fd - + Stream, Socket resource, or numeric file descriptor, e.g. returned by eio_open - + str - + Source string - + length - + Maximum number of bytes to write. - + offset - + Offset from the beginning of file. - + @@ -80,9 +76,9 @@ data - + Arbitrary variable passed to callback. - + @@ -90,9 +86,9 @@ &reftitle.returnvalues; - + eio_write returns request resource on success,&return.falseforfailure;. - + @@ -103,7 +99,6 @@ - - - + &reftitle.setup;
&reftitle.required; - + This extension has libeio library embedded. So you do NOT need to install libeio separately. - +
@@ -19,14 +18,13 @@
&reftitle.resources; - + There are two resource types in this extension: request and request group. - +
-