Home | History | Annotate | Download | only in include
      1 /*
      2  * Copyright (C) 2008 The Android Open Source Project
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  *  * Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  *  * Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in
     12  *    the documentation and/or other materials provided with the
     13  *    distribution.
     14  *
     15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
     18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
     19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
     20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
     22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
     23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
     25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     26  * SUCH DAMAGE.
     27  */
     28 
     29 #pragma once
     30 
     31 /**
     32  * @file poll.h
     33  * @brief Wait for events on a set of file descriptors.
     34  */
     35 
     36 #include <sys/cdefs.h>
     37 #include <linux/poll.h>
     38 #include <signal.h> /* For sigset_t. */
     39 #include <time.h> /* For timespec. */
     40 
     41 __BEGIN_DECLS
     42 
     43 /** The type of a file descriptor count, used by poll() and ppoll(). */
     44 typedef unsigned int nfds_t;
     45 
     46 /**
     47  * [poll(3)](http://man7.org/linux/man-pages/man3/poll.3.html) waits on a set of file descriptors.
     48  *
     49  * Returns the number of ready file descriptors on success, 0 for timeout,
     50  * and returns -1 and sets `errno` on failure.
     51  */
     52 int poll(struct pollfd* _Nullable __fds, nfds_t __count, int __timeout_ms);
     53 
     54 /**
     55  * [ppoll(3)](http://man7.org/linux/man-pages/man3/ppoll.3.html) waits on a set of file descriptors
     56  * or a signal. Set `__timeout` to null for no timeout. Set `__mask` to null to not set the signal
     57  * mask.
     58  *
     59  * Returns the number of ready file descriptors on success, 0 for timeout,
     60  * and returns -1 and sets `errno` on failure.
     61  *
     62  * Available since API level 28.
     63  */
     64 int ppoll(struct pollfd* _Nullable __fds, nfds_t __count, const struct timespec* _Nullable __timeout, const sigset_t* _Nullable __mask) __INTRODUCED_IN(21);
     65 
     66 /**
     67  * Like ppoll() but allows setting a signal mask with RT signals even from a 32-bit process.
     68  */
     69 int ppoll64(struct pollfd* _Nullable  __fds, nfds_t __count, const struct timespec* _Nullable __timeout, const sigset64_t* _Nullable __mask) __INTRODUCED_IN(28);
     70 
     71 #if defined(__BIONIC_INCLUDE_FORTIFY_HEADERS)
     72 #define _POLL_H_
     73 #include <bits/fortify/poll.h>
     74 #undef _POLL_H_
     75 #endif
     76 
     77 __END_DECLS
     78