2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
|
.\" epoll by Davide Libenzi ( efficient event notification retrieval )
|
|
|
|
|
.\" Copyright (C) 2003 Davide Libenzi
|
|
|
|
|
.\"
|
|
|
|
|
.\" This program is free software; 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.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This program 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 program; if not, write to the Free Software
|
|
|
|
|
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
|
.\"
|
|
|
|
|
.\" Davide Libenzi <davidel@xmailserver.org>
|
|
|
|
|
.\"
|
2007-09-20 06:52:22 +00:00
|
|
|
.\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
|
2005-04-04 16:33:48 +00:00
|
|
|
.\" Modified 2005-04-04 by Marko Kohtala <marko.kohtala@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-05-30 05:36:26 +00:00
|
|
|
.TH EPOLL_CREATE 2 2004-06-17 "Linux" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
|
epoll_create \- open an epoll file descriptor
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B #include <sys/epoll.h>
|
|
|
|
|
.sp
|
2007-07-10 04:51:30 +00:00
|
|
|
.BI "int epoll_create(int " size );
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Open an
|
|
|
|
|
.B epoll
|
2007-11-23 18:01:01 +00:00
|
|
|
file descriptor by requesting the kernel to allocate
|
2004-11-03 13:51:07 +00:00
|
|
|
an event backing store dimensioned for
|
|
|
|
|
.I size
|
2007-04-12 22:42:49 +00:00
|
|
|
descriptors.
|
|
|
|
|
The
|
2004-11-03 13:51:07 +00:00
|
|
|
.I size
|
|
|
|
|
is not the maximum size of the backing store but
|
|
|
|
|
just a hint to the kernel about how to dimension internal structures.
|
|
|
|
|
The returned file descriptor will be used for all the subsequent calls to the
|
|
|
|
|
.B epoll
|
2007-04-12 22:42:49 +00:00
|
|
|
interface.
|
|
|
|
|
The file descriptor returned by
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR epoll_create (2)
|
|
|
|
|
must be closed by using
|
|
|
|
|
.BR close (2).
|
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
|
When successful,
|
|
|
|
|
.BR epoll_create (2)
|
2005-07-04 06:47:34 +00:00
|
|
|
returns a non-negative integer identifying the descriptor.
|
2007-04-12 22:42:49 +00:00
|
|
|
When an error occurs,
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR epoll_create (2)
|
2005-06-15 14:10:23 +00:00
|
|
|
returns \-1 and
|
2004-11-03 13:51:07 +00:00
|
|
|
.I errno
|
|
|
|
|
is set appropriately.
|
|
|
|
|
.SH ERRORS
|
|
|
|
|
.TP
|
2005-04-04 16:33:48 +00:00
|
|
|
.B EINVAL
|
|
|
|
|
.I size
|
|
|
|
|
is not positive.
|
|
|
|
|
.TP
|
2004-11-03 13:51:07 +00:00
|
|
|
.B ENFILE
|
|
|
|
|
The system limit on the total number of open files has been reached.
|
|
|
|
|
.TP
|
|
|
|
|
.B ENOMEM
|
|
|
|
|
There was insufficient memory to create the kernel object.
|
|
|
|
|
.SH CONFORMING TO
|
|
|
|
|
.BR epoll_create (2)
|
2006-12-17 01:34:44 +00:00
|
|
|
is Linux specific, and was introduced in kernel 2.5.44.
|
|
|
|
|
.\" The interface should be finalized by Linux kernel 2.5.66.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR close (2),
|
|
|
|
|
.BR epoll_ctl (2),
|
|
|
|
|
.BR epoll_wait (2),
|
2006-04-21 00:29:37 +00:00
|
|
|
.BR epoll (7)
|
