Doug Anson / mbedConnectorInterfaceWithDM

mbed Connector Interface simplification API on top of mbed-client

Fork of mbedConnectorInterfaceV3 by Doug Anson

NOTE:

This repo has been replaced with https://github.com/ARMmbed/mbedConnectorInterface. No further updates will occur with this repo. Please use the github repo instead. Thanks!

mbed-connector-interface/ThreadedResourceObserver.h@0:1f1f55e73248, 2016-02-19 (annotated)

Committer:
ansond
Date:
Fri Feb 19 17:32:14 2016 +0000
Revision:
0:1f1f55e73248
Child:
31:2507e64fcc42
initial checkin

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:1f1f55e73248 1 /**
ansond 0:1f1f55e73248 2 * @file ThreadedResourceObserver.h
ansond 0:1f1f55e73248 3 * @brief mbed CoAP DynamicResource Thread-based observer (header)
ansond 0:1f1f55e73248 4 * @author Doug Anson/Chris Paola
ansond 0:1f1f55e73248 5 * @version 1.0
ansond 0:1f1f55e73248 6 * @see
ansond 0:1f1f55e73248 7 *
ansond 0:1f1f55e73248 8 * Copyright (c) 2014
ansond 0:1f1f55e73248 9 *
ansond 0:1f1f55e73248 10 * Licensed under the Apache License, Version 2.0 (the "License");
ansond 0:1f1f55e73248 11 * you may not use this file except in compliance with the License.
ansond 0:1f1f55e73248 12 * You may obtain a copy of the License at
ansond 0:1f1f55e73248 13 *
ansond 0:1f1f55e73248 14 * http://www.apache.org/licenses/LICENSE-2.0
ansond 0:1f1f55e73248 15 *
ansond 0:1f1f55e73248 16 * Unless required by applicable law or agreed to in writing, software
ansond 0:1f1f55e73248 17 * distributed under the License is distributed on an "AS IS" BASIS,
ansond 0:1f1f55e73248 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ansond 0:1f1f55e73248 19 * See the License for the specific language governing permissions and
ansond 0:1f1f55e73248 20 * limitations under the License.
ansond 0:1f1f55e73248 21 */
ansond 0:1f1f55e73248 22
ansond 0:1f1f55e73248 23 #ifndef __THREADED_RESOURCE_OBSERVER_H__
ansond 0:1f1f55e73248 24 #define __THREADED_RESOURCE_OBSERVER_H__
ansond 0:1f1f55e73248 25
ansond 0:1f1f55e73248 26 // mbed support
ansond 0:1f1f55e73248 27 #include "mbed.h"
ansond 0:1f1f55e73248 28
ansond 0:1f1f55e73248 29 // switch for proper resource observer selection (from mbedEndpointNetwork)
ansond 0:1f1f55e73248 30 #include "configuration.h"
ansond 0:1f1f55e73248 31
ansond 0:1f1f55e73248 32 // mbedConnectorInterface configuration
ansond 0:1f1f55e73248 33 #include "mbedConnectorInterface.h"
ansond 0:1f1f55e73248 34
ansond 0:1f1f55e73248 35 // Thread support
ansond 0:1f1f55e73248 36 #ifdef CONNECTOR_USING_THREADS
ansond 0:1f1f55e73248 37 #include "rtos.h"
ansond 0:1f1f55e73248 38 #endif
ansond 0:1f1f55e73248 39
ansond 0:1f1f55e73248 40 // Base class support
ansond 0:1f1f55e73248 41 #include "ResourceObserver.h"
ansond 0:1f1f55e73248 42
ansond 0:1f1f55e73248 43 class ThreadedResourceObserver : public ResourceObserver {
ansond 0:1f1f55e73248 44 public:
ansond 0:1f1f55e73248 45 /**
ansond 0:1f1f55e73248 46 Default Constructor
ansond 0:1f1f55e73248 47 @param resource input the resource to observe
ansond 0:1f1f55e73248 48 @param sleep_time input the time for the observation thread to sleep (in ms)
ansond 0:1f1f55e73248 49 */
ansond 0:1f1f55e73248 50 ThreadedResourceObserver(DynamicResource *resource,int sleep_time = OBS_PERIOD_MS);
ansond 0:1f1f55e73248 51
ansond 0:1f1f55e73248 52 /**
ansond 0:1f1f55e73248 53 Destructor
ansond 0:1f1f55e73248 54 */
ansond 0:1f1f55e73248 55 virtual ~ThreadedResourceObserver();
ansond 0:1f1f55e73248 56
ansond 0:1f1f55e73248 57 /**
ansond 0:1f1f55e73248 58 begin the observation
ansond 0:1f1f55e73248 59 */
ansond 0:1f1f55e73248 60 virtual void beginObservation();
ansond 0:1f1f55e73248 61
ansond 0:1f1f55e73248 62 /**
ansond 0:1f1f55e73248 63 stop the observation
ansond 0:1f1f55e73248 64 */
ansond 0:1f1f55e73248 65 virtual void stopObservation();
ansond 0:1f1f55e73248 66
ansond 0:1f1f55e73248 67 /**
ansond 0:1f1f55e73248 68 thread invoke function (static)
ansond 0:1f1f55e73248 69 */
ansond 0:1f1f55e73248 70 static void _observation_notifier(void const *instance);
ansond 0:1f1f55e73248 71
ansond 0:1f1f55e73248 72 private:
ansond 0:1f1f55e73248 73 #ifdef CONNECTOR_USING_THREADS
ansond 0:1f1f55e73248 74 Thread m_observation_thread;
ansond 0:1f1f55e73248 75 #endif
ansond 0:1f1f55e73248 76 };
ansond 0:1f1f55e73248 77
ansond 0:1f1f55e73248 78 #endif // __THREADED_RESOURCE_OBSERVER_H__