mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/mbed_poll.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
178:79309dc6340a 
mbed library release version 165

Who changed what in which revision?

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