test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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