Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

platform/mbed_poll.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
NYX 0:85b3fd62ea1a 1 /* mbed Microcontroller Library
NYX 0:85b3fd62ea1a 2 * Copyright (c) 2017 ARM Limited
NYX 0:85b3fd62ea1a 3 *
NYX 0:85b3fd62ea1a 4 * Licensed under the Apache License, Version 2.0 (the "License");
NYX 0:85b3fd62ea1a 5 * you may not use this file except in compliance with the License.
NYX 0:85b3fd62ea1a 6 * You may obtain a copy of the License at
NYX 0:85b3fd62ea1a 7 *
NYX 0:85b3fd62ea1a 8 * http://www.apache.org/licenses/LICENSE-2.0
NYX 0:85b3fd62ea1a 9 *
NYX 0:85b3fd62ea1a 10 * Unless required by applicable law or agreed to in writing, software
NYX 0:85b3fd62ea1a 11 * distributed under the License is distributed on an "AS IS" BASIS,
NYX 0:85b3fd62ea1a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
NYX 0:85b3fd62ea1a 13 * See the License for the specific language governing permissions and
NYX 0:85b3fd62ea1a 14 * limitations under the License.
NYX 0:85b3fd62ea1a 15 */
NYX 0:85b3fd62ea1a 16 #ifndef MBED_POLL_H
NYX 0:85b3fd62ea1a 17 #define MBED_POLL_H
NYX 0:85b3fd62ea1a 18
NYX 0:85b3fd62ea1a 19 #define POLLIN 0x0001 ///< Data may be read without blocking
NYX 0:85b3fd62ea1a 20 #define POLLOUT 0x0010 ///< Data may be written without blocking
NYX 0:85b3fd62ea1a 21 #define POLLERR 0x1000 ///< An error has occurred on the device or stream
NYX 0:85b3fd62ea1a 22 #define POLLHUP 0x2000 ///< The device has been disconnected
NYX 0:85b3fd62ea1a 23 #define POLLNVAL 0x4000 ///< The specified file handle value is invalid
NYX 0:85b3fd62ea1a 24
NYX 0:85b3fd62ea1a 25 namespace mbed {
NYX 0:85b3fd62ea1a 26
NYX 0:85b3fd62ea1a 27 class FileHandle;
NYX 0:85b3fd62ea1a 28
NYX 0:85b3fd62ea1a 29 /** \addtogroup platform */
NYX 0:85b3fd62ea1a 30
NYX 0:85b3fd62ea1a 31
NYX 0:85b3fd62ea1a 32 struct pollfh {
NYX 0:85b3fd62ea1a 33 FileHandle *fh;
NYX 0:85b3fd62ea1a 34 short events;
NYX 0:85b3fd62ea1a 35 short revents;
NYX 0:85b3fd62ea1a 36 };
NYX 0:85b3fd62ea1a 37
NYX 0:85b3fd62ea1a 38 /** A mechanism to multiplex input/output over a set of file handles(file descriptors).
NYX 0:85b3fd62ea1a 39 * For every file handle provided, poll() examines it for any events registered for that particular
NYX 0:85b3fd62ea1a 40 * file handle.
NYX 0:85b3fd62ea1a 41 *
NYX 0:85b3fd62ea1a 42 * @param fhs an array of PollFh struct carrying a FileHandle and bitmasks of events
NYX 0:85b3fd62ea1a 43 * @param nfhs number of file handles
NYX 0:85b3fd62ea1a 44 * @param timeout timer value to timeout or -1 for loop forever
NYX 0:85b3fd62ea1a 45 *
NYX 0:85b3fd62ea1a 46 * @return number of file handles selected (for which revents is non-zero). 0 if timed out with nothing selected. -1 for error.
NYX 0:85b3fd62ea1a 47 */
NYX 0:85b3fd62ea1a 48 int poll(pollfh fhs[], unsigned nfhs, int timeout);
NYX 0:85b3fd62ea1a 49
NYX 0:85b3fd62ea1a 50 } // namespace mbed
NYX 0:85b3fd62ea1a 51
NYX 0:85b3fd62ea1a 52 #endif //MBED_POLL_H