Doug Anson / mbedConnectorInterface

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   IoT_LED_demo ServoTest uWater_Project hackathon ... more

api/TaskletResourceObserver.h@34:03a8cc428b8b, 2015-04-08 (annotated)

Committer:
ansond
Date:
Wed Apr 08 21:18:51 2015 +0000
Revision:
34:03a8cc428b8b
Parent:
31:bacc63106754
Child:
35:f12e61aaf004
updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 30:113c2a1d8db2 1 /**
ansond 30:113c2a1d8db2 2 * @file TaskletResourceObserver.h
ansond 30:113c2a1d8db2 3 * @brief mbed CoAP DynamicResource Tasklet-based observer (header)
ansond 30:113c2a1d8db2 4 * @author Doug Anson/Chris Paola
ansond 30:113c2a1d8db2 5 * @version 1.0
ansond 30:113c2a1d8db2 6 * @see
ansond 30:113c2a1d8db2 7 *
ansond 30:113c2a1d8db2 8 * Copyright (c) 2014
ansond 30:113c2a1d8db2 9 *
ansond 30:113c2a1d8db2 10 * Licensed under the Apache License, Version 2.0 (the "License");
ansond 30:113c2a1d8db2 11 * you may not use this file except in compliance with the License.
ansond 30:113c2a1d8db2 12 * You may obtain a copy of the License at
ansond 30:113c2a1d8db2 13 *
ansond 30:113c2a1d8db2 14 * http://www.apache.org/licenses/LICENSE-2.0
ansond 30:113c2a1d8db2 15 *
ansond 30:113c2a1d8db2 16 * Unless required by applicable law or agreed to in writing, software
ansond 30:113c2a1d8db2 17 * distributed under the License is distributed on an "AS IS" BASIS,
ansond 30:113c2a1d8db2 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ansond 30:113c2a1d8db2 19 * See the License for the specific language governing permissions and
ansond 30:113c2a1d8db2 20 * limitations under the License.
ansond 30:113c2a1d8db2 21 */
ansond 30:113c2a1d8db2 22
ansond 30:113c2a1d8db2 23 #ifndef __TASKLET_RESOURCE_OBSERVER_H__
ansond 30:113c2a1d8db2 24 #define __TASKLET_RESOURCE_OBSERVER_H__
ansond 30:113c2a1d8db2 25
ansond 30:113c2a1d8db2 26 // Base class support
ansond 30:113c2a1d8db2 27 #include "ResourceObserver.h"
ansond 30:113c2a1d8db2 28
ansond 31:bacc63106754 29 // Tasklet support under network_stubs.h in mbedEndpointNetwork
ansond 31:bacc63106754 30 #ifdef CONNECTOR_USING_TASKLETS
ansond 31:bacc63106754 31 #include "network_stubs.h"
ansond 31:bacc63106754 32 #endif
ansond 31:bacc63106754 33
ansond 30:113c2a1d8db2 34 class TaskletResourceObserver : public ResourceObserver {
ansond 30:113c2a1d8db2 35 public:
ansond 30:113c2a1d8db2 36 /**
ansond 30:113c2a1d8db2 37 Default Constructor
ansond 30:113c2a1d8db2 38 @param resource input the resource to observe
ansond 31:bacc63106754 39 @param timer_id input the id for our timer (can be index value of each resource that is observed...)
ansond 31:bacc63106754 40 @param sleep_time input the time for the observation tasklet to sleep (in ms)
ansond 30:113c2a1d8db2 41 */
ansond 31:bacc63106754 42 TaskletResourceObserver(DynamicResource *resource,uint8_t timer_id, int sleep_time = NSP_RD_UPDATE_PERIOD);
ansond 30:113c2a1d8db2 43
ansond 30:113c2a1d8db2 44 /**
ansond 30:113c2a1d8db2 45 Copy Constructor
ansond 30:113c2a1d8db2 46 */
ansond 30:113c2a1d8db2 47 TaskletResourceObserver(const TaskletResourceObserver &observer);
ansond 30:113c2a1d8db2 48
ansond 30:113c2a1d8db2 49 /**
ansond 30:113c2a1d8db2 50 Destructor
ansond 30:113c2a1d8db2 51 */
ansond 30:113c2a1d8db2 52 virtual ~TaskletResourceObserver();
ansond 30:113c2a1d8db2 53
ansond 30:113c2a1d8db2 54 /**
ansond 30:113c2a1d8db2 55 begin the observation
ansond 30:113c2a1d8db2 56 */
ansond 30:113c2a1d8db2 57 virtual void beginObservation();
ansond 31:bacc63106754 58
ansond 31:bacc63106754 59 /**
ansond 31:bacc63106754 60 stop the observation
ansond 31:bacc63106754 61 */
ansond 31:bacc63106754 62 virtual void stopObservation();
ansond 31:bacc63106754 63
ansond 31:bacc63106754 64 #ifdef CONNECTOR_USING_TASKLETS
ansond 31:bacc63106754 65 /**
ansond 31:bacc63106754 66 tasklet invoke function (static)
ansond 31:bacc63106754 67 */
ansond 31:bacc63106754 68 static void _observation_notifier(arm_event_s *event);
ansond 34:03a8cc428b8b 69 #endif
ansond 34:03a8cc428b8b 70
ansond 34:03a8cc428b8b 71
ansond 34:03a8cc428b8b 72 #ifdef CONNECTOR_USING_TASKLETS
ansond 31:bacc63106754 73 /**
ansond 31:bacc63106754 74 set the current event
ansond 31:bacc63106754 75 @param event input the current event
ansond 31:bacc63106754 76 */
ansond 31:bacc63106754 77 void setEvent(arm_event_s *event);
ansond 31:bacc63106754 78 #endif
ansond 31:bacc63106754 79
ansond 31:bacc63106754 80 /**
ansond 31:bacc63106754 81 start the tasklet timer
ansond 31:bacc63106754 82 */
ansond 31:bacc63106754 83 void startTimer();
ansond 31:bacc63106754 84
ansond 31:bacc63106754 85 /**
ansond 31:bacc63106754 86 get the tasklet timer ID
ansond 31:bacc63106754 87 @return timer id
ansond 31:bacc63106754 88 */
ansond 31:bacc63106754 89 uint8_t getTimerID();
ansond 31:bacc63106754 90
ansond 30:113c2a1d8db2 91 private:
ansond 31:bacc63106754 92 int m_tasklet_id;
ansond 31:bacc63106754 93 #ifdef CONNECTOR_USING_TASKLETS
ansond 31:bacc63106754 94 arm_event_s *m_event;
ansond 31:bacc63106754 95 #endif
ansond 31:bacc63106754 96 uint8_t m_timer_id;
ansond 31:bacc63106754 97 bool m_timer_active;
ansond 30:113c2a1d8db2 98 };
ansond 30:113c2a1d8db2 99
ansond 30:113c2a1d8db2 100 #endif // __TASKLET_RESOURCE_OBSERVER_H__