diff options
Diffstat (limited to 'man3/mpool.3')
| -rw-r--r-- | man3/mpool.3 | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/man3/mpool.3 b/man3/mpool.3 index 10ef507a61..56e105a1b3 100644 --- a/man3/mpool.3 +++ b/man3/mpool.3 @@ -72,7 +72,7 @@ of files. The buffers may be shared between processes. .PP The function -.I mpool_open +.IR mpool_open () initializes a memory pool. The .I key @@ -104,7 +104,7 @@ buffers, but will be the largest value specified by any of the processes sharing the file. .PP The -.I mpool_filter +.IR mpool_filter () function is intended to make transparent input and output processing of the pages possible. If the @@ -120,7 +120,7 @@ Both functions are called with the pointer, the page number and a pointer to the page to being read or written. .PP The function -.I mpool_new +.IR mpool_new () takes an MPOOL pointer and an address as arguments. If a new page can be allocated, a pointer to the page is returned and the page number is stored into the @@ -129,21 +129,21 @@ address. Otherwise, NULL is returned and errno is set. .PP The function -.I mpool_get +.IR mpool_get () takes a MPOOL pointer and a page number as arguments. If the page exists, a pointer to the page is returned. Otherwise, NULL is returned and errno is set. The flags parameter is not currently used. .PP The function -.I mpool_put +.IR mpool_put () unpins the page referenced by .IR pgaddr . .I Pgaddr must be an address previously returned by -.I mpool_get +.IR mpool_get () or -.IR mpool_new . +.IR mpool_new (). The flag value is specified by .IR or 'ing any of the following values: @@ -151,35 +151,35 @@ any of the following values: MPOOL_DIRTY The page has been modified and needs to be written to the backing file. .PP -.I Mpool_put +.IR Mpool_put () returns 0 on success and \-1 if an error occurs. .PP The function -.I mpool_sync +.IR mpool_sync () writes all modified pages associated with the MPOOL pointer to the backing file. -.I Mpool_sync +.IR Mpool_sync () returns 0 on success and \-1 if an error occurs. .PP The -.I mpool_close +.IR mpool_close () function free's up any allocated memory associated with the memory pool cookie. Modified pages are .B not written to the backing file. -.I Mpool_close +.IR Mpool_close () returns 0 on success and \-1 if an error occurs. .SH ERRORS The -.I mpool_open +.IR mpool_open () function may fail and set .I errno for any of the errors specified for the library routine .IR malloc (3). .PP The -.I mpool_get +.IR mpool_get () function may fail and set .I errno for the following: @@ -188,9 +188,9 @@ for the following: The requested record doesn't exist. .PP The -.I mpool_new +.IR mpool_new () and -.I mpool_get +.IR mpool_get () functions may fail and set .I errno for any of the errors specified for the library routines @@ -200,14 +200,14 @@ and .IR malloc (3). .PP The -.I mpool_sync +.IR mpool_sync () function may fail and set .I errno for any of the errors specified for the library routine .IR write (2). .PP The -.I mpool_close +.IR mpool_close () function may fail and set .I errno for any of the errors specified for the library routine |