Timothy Beight / Mbed 2 deprecated 6_songs-from-the-cloud

This is a fork due to permission issues

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of 6_songs-from-the-cloud by MakingMusicWorkshop

mbed-client/mbed-rtos/rtos/RtosTimer.h@1:0ddbe2d3319c, 2016-05-19 (annotated)

Committer:
timbeight
Date:
Thu May 19 16:02:10 2016 +0000
Revision:
1:0ddbe2d3319c
Parent:
0:f7c60d3e7b8a 
This is my first commit while in the class.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
maclobdell 0:f7c60d3e7b8a 1 /* mbed Microcontroller Library
maclobdell 0:f7c60d3e7b8a 2 * Copyright (c) 2006-2012 ARM Limited
maclobdell 0:f7c60d3e7b8a 3 *
maclobdell 0:f7c60d3e7b8a 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
maclobdell 0:f7c60d3e7b8a 5 * of this software and associated documentation files (the "Software"), to deal
maclobdell 0:f7c60d3e7b8a 6 * in the Software without restriction, including without limitation the rights
maclobdell 0:f7c60d3e7b8a 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
maclobdell 0:f7c60d3e7b8a 8 * copies of the Software, and to permit persons to whom the Software is
maclobdell 0:f7c60d3e7b8a 9 * furnished to do so, subject to the following conditions:
maclobdell 0:f7c60d3e7b8a 10 *
maclobdell 0:f7c60d3e7b8a 11 * The above copyright notice and this permission notice shall be included in
maclobdell 0:f7c60d3e7b8a 12 * all copies or substantial portions of the Software.
maclobdell 0:f7c60d3e7b8a 13 *
maclobdell 0:f7c60d3e7b8a 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
maclobdell 0:f7c60d3e7b8a 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
maclobdell 0:f7c60d3e7b8a 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
maclobdell 0:f7c60d3e7b8a 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
maclobdell 0:f7c60d3e7b8a 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
maclobdell 0:f7c60d3e7b8a 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
maclobdell 0:f7c60d3e7b8a 20 * SOFTWARE.
maclobdell 0:f7c60d3e7b8a 21 */
maclobdell 0:f7c60d3e7b8a 22 #ifndef RTOS_TIMER_H
maclobdell 0:f7c60d3e7b8a 23 #define RTOS_TIMER_H
maclobdell 0:f7c60d3e7b8a 24
maclobdell 0:f7c60d3e7b8a 25 #include <stdint.h>
maclobdell 0:f7c60d3e7b8a 26 #include "cmsis_os.h"
maclobdell 0:f7c60d3e7b8a 27
maclobdell 0:f7c60d3e7b8a 28 namespace rtos {
maclobdell 0:f7c60d3e7b8a 29
maclobdell 0:f7c60d3e7b8a 30 /** The RtosTimer class allow creating and and controlling of timer functions in the system.
maclobdell 0:f7c60d3e7b8a 31 A timer function is called when a time period expires whereby both on-shot and
maclobdell 0:f7c60d3e7b8a 32 periodic timers are possible. A timer can be started, restarted, or stopped.
maclobdell 0:f7c60d3e7b8a 33
maclobdell 0:f7c60d3e7b8a 34 Timers are handled in the thread osTimerThread.
maclobdell 0:f7c60d3e7b8a 35 Callback functions run under control of this thread and may use CMSIS-RTOS API calls.
maclobdell 0:f7c60d3e7b8a 36 */
maclobdell 0:f7c60d3e7b8a 37 class RtosTimer {
maclobdell 0:f7c60d3e7b8a 38 public:
maclobdell 0:f7c60d3e7b8a 39 /** Create and Start timer.
maclobdell 0:f7c60d3e7b8a 40 @param task name of the timer call back function.
maclobdell 0:f7c60d3e7b8a 41 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
maclobdell 0:f7c60d3e7b8a 42 @param argument argument to the timer call back function. (default: NULL)
maclobdell 0:f7c60d3e7b8a 43 */
maclobdell 0:f7c60d3e7b8a 44 RtosTimer(void (*task)(void const *argument),
maclobdell 0:f7c60d3e7b8a 45 os_timer_type type=osTimerPeriodic,
maclobdell 0:f7c60d3e7b8a 46 void *argument=NULL);
maclobdell 0:f7c60d3e7b8a 47
maclobdell 0:f7c60d3e7b8a 48 /** Stop the timer.
maclobdell 0:f7c60d3e7b8a 49 @return status code that indicates the execution status of the function.
maclobdell 0:f7c60d3e7b8a 50 */
maclobdell 0:f7c60d3e7b8a 51 osStatus stop(void);
maclobdell 0:f7c60d3e7b8a 52
maclobdell 0:f7c60d3e7b8a 53 /** start a timer.
maclobdell 0:f7c60d3e7b8a 54 @param millisec time delay value of the timer.
maclobdell 0:f7c60d3e7b8a 55 @return status code that indicates the execution status of the function.
maclobdell 0:f7c60d3e7b8a 56 */
maclobdell 0:f7c60d3e7b8a 57 osStatus start(uint32_t millisec);
maclobdell 0:f7c60d3e7b8a 58
maclobdell 0:f7c60d3e7b8a 59 ~RtosTimer();
maclobdell 0:f7c60d3e7b8a 60
maclobdell 0:f7c60d3e7b8a 61 private:
maclobdell 0:f7c60d3e7b8a 62 osTimerId _timer_id;
maclobdell 0:f7c60d3e7b8a 63 osTimerDef_t _timer;
maclobdell 0:f7c60d3e7b8a 64 #ifdef CMSIS_OS_RTX
maclobdell 0:f7c60d3e7b8a 65 uint32_t _timer_data[5];
maclobdell 0:f7c60d3e7b8a 66 #endif
maclobdell 0:f7c60d3e7b8a 67 };
maclobdell 0:f7c60d3e7b8a 68
maclobdell 0:f7c60d3e7b8a 69 }
maclobdell 0:f7c60d3e7b8a 70
maclobdell 0:f7c60d3e7b8a 71 #endif