Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

Timeout.h@92:f7fcbaa5f1b5, 2016-06-12 (annotated)

Committer:
mrsoundhar
Date:
Sun Jun 12 16:45:04 2016 +0000
Revision:
92:f7fcbaa5f1b5
Parent:
27:7110ebee3484
Child:
43:e2ed12d17f06
Soundharrajan

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 9:cf0d45ce28a6 1 /* mbed Microcontroller Library - Timeout
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
simon.ford@mbed.co.uk 9:cf0d45ce28a6 5 #ifndef MBED_TIMEOUT_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 6 #define MBED_TIMEOUT_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 7
simon.ford@mbed.co.uk 9:cf0d45ce28a6 8 #include "Ticker.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 9
simon.ford@mbed.co.uk 9:cf0d45ce28a6 10 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 11
simon.ford@mbed.co.uk 9:cf0d45ce28a6 12 /* Class: Timeout
simon.ford@mbed.co.uk 9:cf0d45ce28a6 13 * A Timeout is used to call a function at a point in the future
simon.ford@mbed.co.uk 9:cf0d45ce28a6 14 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 15 * You can use as many seperate Timeout objects as you require.
rolf.meyer@arm.com 11:1c1ebd0324fa 16 *
rolf.meyer@arm.com 11:1c1ebd0324fa 17 * Example:
rolf.meyer@arm.com 11:1c1ebd0324fa 18 * > // Blink until timeout.
rolf.meyer@arm.com 11:1c1ebd0324fa 19 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 20 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * > Timeout timeout;
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * > DigitalOut led(LED1);
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * > int on = 1;
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * > void attimeout() {
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * > on = 0;
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 31 * > int main() {
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * > timeout.attach(&attimeout, 5);
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * > while(on) {
rolf.meyer@arm.com 11:1c1ebd0324fa 34 * > led = !led;
rolf.meyer@arm.com 11:1c1ebd0324fa 35 * > wait(0.2);
rolf.meyer@arm.com 11:1c1ebd0324fa 36 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 37 * > }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 38 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 39 class Timeout : public Ticker {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 40
simon.ford@mbed.co.uk 9:cf0d45ce28a6 41 #if 0 // For documentation
simon.ford@mbed.co.uk 9:cf0d45ce28a6 42
simon.ford@mbed.co.uk 9:cf0d45ce28a6 43 /* Function: attach
simon.ford@mbed.co.uk 9:cf0d45ce28a6 44 * Attach a function to be called by the Timeout, specifiying the delay in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 45 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 46 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 47 * fptr - pointer to the function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 48 * t - the time before the call in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 49 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 50 void attach(void (*fptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 51 attach_us(fptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 52 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 53
simon.ford@mbed.co.uk 9:cf0d45ce28a6 54 /* Function: attach
simon.ford@mbed.co.uk 9:cf0d45ce28a6 55 * Attach a member function to be called by the Timeout, specifiying the delay in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 56 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 57 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 58 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 9:cf0d45ce28a6 59 * mptr - pointer to the member function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 60 * t - the time before the calls in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 61 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 62 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 63 void attach(T* tptr, void (T::*mptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 64 attach_us(tptr, mptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 65 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 66
simon.ford@mbed.co.uk 9:cf0d45ce28a6 67 /* Function: attach_us
simon.ford@mbed.co.uk 9:cf0d45ce28a6 68 * Attach a function to be called by the Timeout, specifiying the delay in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 69 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 70 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 71 * fptr - pointer to the function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 72 * t - the time before the call in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 73 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 74 void attach_us(void (*fptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 75 _function.attach(fptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 76 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 77 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 78
simon.ford@mbed.co.uk 9:cf0d45ce28a6 79 /* Function: attach_us
simon.ford@mbed.co.uk 9:cf0d45ce28a6 80 * Attach a member function to be called by the Timeout, specifiying the delay in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 81 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 82 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 83 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 9:cf0d45ce28a6 84 * mptr - pointer to the member function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 85 * t - the time before the call in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 86 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 87 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 88 void attach_us(T* tptr, void (T::*mptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 89 _function.attach(tptr, mptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 90 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 91 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 92
simon.ford@mbed.co.uk 9:cf0d45ce28a6 93 /* Function: detach
simon.ford@mbed.co.uk 9:cf0d45ce28a6 94 * Detach the function
simon.ford@mbed.co.uk 9:cf0d45ce28a6 95 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 96 void detach();
simon.ford@mbed.co.uk 9:cf0d45ce28a6 97
simon.ford@mbed.co.uk 9:cf0d45ce28a6 98 #endif
simon.ford@mbed.co.uk 9:cf0d45ce28a6 99
simon.ford@mbed.co.uk 9:cf0d45ce28a6 100 protected:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 101
rolf.meyer@arm.com 11:1c1ebd0324fa 102 virtual void handler();
simon.ford@mbed.co.uk 9:cf0d45ce28a6 103
rolf.meyer@arm.com 11:1c1ebd0324fa 104 };
rolf.meyer@arm.com 11:1c1ebd0324fa 105
rolf.meyer@arm.com 11:1c1ebd0324fa 106 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 107
simon.ford@mbed.co.uk 9:cf0d45ce28a6 108 #endif