BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/platform/mbed_poll.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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