mbed library sources
Fork of mbed-src by
Diff: api/Timeout.h
- Revision:
- 10:3bc89ef62ce7
- Parent:
- 9:0ce32e54c9a7
- Child:
- 13:0645d8841f51
diff -r 0ce32e54c9a7 -r 3bc89ef62ce7 api/Timeout.h --- a/api/Timeout.h Mon Jun 10 16:03:00 2013 +0100 +++ b/api/Timeout.h Fri Jun 14 17:49:17 2013 +0100 @@ -1,59 +1,59 @@ -/* mbed Microcontroller Library - * Copyright (c) 2006-2013 ARM Limited - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -#ifndef MBED_TIMEOUT_H -#define MBED_TIMEOUT_H - -#include "Ticker.h" - -namespace mbed { - -/** A Timeout is used to call a function at a point in the future - * - * You can use as many seperate Timeout objects as you require. - * - * Example: - * @code - * // Blink until timeout. - * - * #include "mbed.h" - * - * Timeout timeout; - * DigitalOut led(LED1); - * - * int on = 1; - * - * void attimeout() { - * on = 0; - * } - * - * int main() { - * timeout.attach(&attimeout, 5); - * while(on) { - * led = !led; - * wait(0.2); - * } - * } - * @endcode - */ -class Timeout : public Ticker { - -protected: - virtual void handler(); -}; - -} // namespace mbed - -#endif +/* mbed Microcontroller Library + * Copyright (c) 2006-2013 ARM Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#ifndef MBED_TIMEOUT_H +#define MBED_TIMEOUT_H + +#include "Ticker.h" + +namespace mbed { + +/** A Timeout is used to call a function at a point in the future + * + * You can use as many seperate Timeout objects as you require. + * + * Example: + * @code + * // Blink until timeout. + * + * #include "mbed.h" + * + * Timeout timeout; + * DigitalOut led(LED1); + * + * int on = 1; + * + * void attimeout() { + * on = 0; + * } + * + * int main() { + * timeout.attach(&attimeout, 5); + * while(on) { + * led = !led; + * wait(0.2); + * } + * } + * @endcode + */ +class Timeout : public Ticker { + +protected: + virtual void handler(); +}; + +} // namespace mbed + +#endif