Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/platform/mbed_poll.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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