forked
Embed:
(wiki syntax)
Show/hide line numbers
Timeout.h
00001 /* mbed Microcontroller Library 00002 * Copyright (c) 2006-2013 ARM Limited 00003 * 00004 * Licensed under the Apache License, Version 2.0 (the "License"); 00005 * you may not use this file except in compliance with the License. 00006 * You may obtain a copy of the License at 00007 * 00008 * http://www.apache.org/licenses/LICENSE-2.0 00009 * 00010 * Unless required by applicable law or agreed to in writing, software 00011 * distributed under the License is distributed on an "AS IS" BASIS, 00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 * See the License for the specific language governing permissions and 00014 * limitations under the License. 00015 */ 00016 #ifndef MBED_TIMEOUT_H 00017 #define MBED_TIMEOUT_H 00018 00019 #include "drivers/Ticker.h" 00020 #include "platform/NonCopyable.h" 00021 00022 namespace mbed { 00023 /** \addtogroup drivers */ 00024 00025 /** A Timeout is used to call a function at a point in the future 00026 * 00027 * You can use as many seperate Timeout objects as you require. 00028 * 00029 * @note Synchronization level: Interrupt safe 00030 * 00031 * Example: 00032 * @code 00033 * // Blink until timeout. 00034 * 00035 * #include "mbed.h" 00036 * 00037 * Timeout timeout; 00038 * DigitalOut led(LED1); 00039 * 00040 * int on = 1; 00041 * 00042 * void attimeout() { 00043 * on = 0; 00044 * } 00045 * 00046 * int main() { 00047 * timeout.attach(&attimeout, 5); 00048 * while(on) { 00049 * led = !led; 00050 * wait(0.2); 00051 * } 00052 * } 00053 * @endcode 00054 * @ingroup drivers 00055 */ 00056 class Timeout : public Ticker, private NonCopyable<Timeout> { 00057 00058 protected: 00059 virtual void handler(); 00060 }; 00061 00062 } // namespace mbed 00063 00064 #endif
Generated on Tue Jul 12 2022 16:02:33 by 1.7.2