Basic file structure for poll() API

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@1257 42af7a65-404d-4744-a932-0658087f49c3
2026-05-24 07:46:16 +08:00 · 2008-11-16 17:19:38 +00:00
parent 85911f6a9d
commit 57c41ff2fc
3 changed files with 227 additions and 5 deletions
@@ -0,0 +1,125 @@
+/****************************************************************************
+ * include/poll.h
+ *
+ *   Copyright (C) 2008 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name NuttX nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+#ifndef __INCLUDE_POLL_H
+#define __INCLUDE_POLL_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <sys/types.h>
+#include <semaphore.h>
+
+/****************************************************************************
+ * Definitions
+ ****************************************************************************/
+
+/* Poll event definitions:
+ *
+ *   POLLIN
+ *     Data other than high-priority data may be read without blocking.
+ *   POLLRDNORM
+ *     Normal data may be read without blocking.
+ *   POLLRDBAND
+ *     Priority data may be read without blocking.
+ *   POLLPRI
+ *     High priority data may be read without blocking.
+ *   POLLOUT
+ *     Normal data may be written without blocking.
+ *   POLLWRNORM
+ *     Equivalent to POLLOUT.
+ *   POLLWRBAND
+ *     Priority data may be written.
+ *   POLLERR
+ *     An error has occurred (revents only).
+ *   POLLHUP
+ *     Device has been disconnected (revents only).
+ *   POLLNVAL
+ *     Invalid fd member (revents only).
+ */
+
+#define POLLIN       (0x01)  /* NuttX does not make priority distinctions */
+#define POLLRDNORM   (0x01)
+#define POLLRDBAND   (0x01)
+#define POLLPRI      (0x01)
+
+#define POLLOUT      (0x02)  /* NuttX does not make priority distinctions */
+#define POLLWRNORM   (0x02)
+#define POLLWRBAND   (0x02)
+
+#define POLLERR      (0x04)
+#define POLLHUP      (0x08)
+#define POLLNVAL     (0x10)
+
+/****************************************************************************
+ * Public Type Definitions
+ ****************************************************************************/
+
+typedef unsigned int nfds_t;
+
+struct pollfd
+{
+  int    fd;       /* The descriptor being polled */
+  sem_t  *sem;     /* Pointer to semaphore used to post output event */
+  ubyte  events;   /* The input event flags */
+  ubyte  revents;  /* The output event flags */
+};
+
+/****************************************************************************
+ * Public Variables
+ ****************************************************************************/
+
+#undef EXTERN
+#if defined(__cplusplus)
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+EXTERN int poll(FAR struct pollfd *fds, nfds_t nfds, int timeout);
+
+#undef EXTERN
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* __INCLUDE_POLL_H */