Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/platform/mbed_poll.h@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:
borlanic
Date:
Mon May 14 11:29:06 2018 +0000
Revision:
0:fbdae7e6d805
BBR

Who changed what in which revision?

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