Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/mbed_poll.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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