man-pages/man3/aio_fsync.3

110 lines
2.7 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
.\" USA.
.\"
.TH AIO_FSYNC 3 2010-10-02 "" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
aio_fsync \- asynchronous file synchronization
.SH SYNOPSIS
.B "#include <aio.h>"
.sp
.BI "int aio_fsync(int " op ", struct aiocb *" aiocbp );
2008-04-25 06:35:53 +00:00
.sp
Link with \fI\-lrt\fP.
2004-11-03 13:51:07 +00:00
.SH DESCRIPTION
The
.BR aio_fsync ()
2004-11-03 13:51:07 +00:00
function does a sync on all outstanding asynchronous I/O operations
associated with
.IR aiocbp\->aio_fildes .
(See
.BR aio (7)
for a description of the
.I aiocb
structure.)
2004-11-03 13:51:07 +00:00
.LP
More precisely, if
.I op
2007-06-22 19:42:52 +00:00
is
.BR O_SYNC ,
then all currently queued I/O operations shall be
2004-11-03 13:51:07 +00:00
completed as if by a call of
.BR fsync (2),
and if
.I op
2007-06-22 19:42:52 +00:00
is
.BR O_DSYNC ,
this call is the asynchronous analog of
2004-11-03 13:51:07 +00:00
.BR fdatasync (2).
2005-07-18 12:43:00 +00:00
Note that this is a request only \(em this call does not wait
2004-11-03 13:51:07 +00:00
for I/O completion.
.LP
Apart from
.I aio_fildes
the only field in the structure pointed to by
.I aiocbp
that is used by this call is the
.I aio_sigevent
field (a
.I sigevent
structure, described in
.BR sigevent (7)),
which indicates the desired type of asynchronous notification at completion.
.\" FIXME more sigevent details are probably needed here.
2004-11-03 13:51:07 +00:00
All other fields are ignored.
.SH "RETURN VALUE"
On success (the sync request was successfully queued)
2007-06-08 03:17:37 +00:00
this function returns 0.
On error \-1 is returned, and
2004-11-03 13:51:07 +00:00
.I errno
is set appropriately.
.SH ERRORS
.TP
.B EAGAIN
Out of resources.
.TP
.B EBADF
.I aio_fildes
is not a valid file descriptor open for writing.
.TP
.B EINVAL
No synchronized I/O for this file is supported, or
.I op
2007-06-22 19:42:52 +00:00
is not
.B O_SYNC
or
.BR O_DSYNC .
.SH VERSIONS
The
.BR aio_fsync ()
function is available since glibc 2.1.
2004-11-03 13:51:07 +00:00
.SH "CONFORMING TO"
POSIX.1-2001, POSIX.1-2008.
2004-11-03 13:51:07 +00:00
.SH "SEE ALSO"
.BR aio_cancel (3),
.BR aio_error (3),
.BR aio_read (3),
.BR aio_return (3),
.BR aio_suspend (3),
.BR aio_write (3),
.BR aio (7),
.BR sigevent (7)