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/TickerResourceObserver.h

Committer:
ansond
Date:
2017-09-26
Revision:
127:b4a661ff6fb9
Parent:
126:f37e34daa100

File content as of revision 127:b4a661ff6fb9:

/**
 * @file    TickerResourceObserver.h
 * @brief   mbed CoAP DynamicResource Ticker-based observer (header)
 * @author  Doug Anson/Chris Paola
 * @version 1.0
 * @see
 *
 * Copyright (c) 2014
 *
 * 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 __TICKER_RESOURCE_OBSERVER_H__
#define __TICKER_RESOURCE_OBSERVER_H__

// mbedConnectorInterface configuration
#include "mbed-connector-interface/mbedConnectorInterface.h"

#ifdef CONNECTOR_USING_TICKER

// mbed support
#if defined(MCI_USE_YOTTA)
    // mbed support
    #include "mbed-drivers/mbed.h"
#else
    // mbed support
    #include "mbed.h"
#endif

// Base class support
#include "mbed-connector-interface/ResourceObserver.h"

class TickerResourceObserver : public ResourceObserver {
    public:
        /**
        Default Constructor
        @param resource input the resource to observe
        @param timer_id input the id for our timer (can be index value of each resource that is observed...)
        @param sleep_time input the time for the observation tasklet to sleep (in whole seconds...)
        */
        TickerResourceObserver(DynamicResource *resource,int sleep_time = DEFAULT_OBS_PERIOD);
        
        /**
        Copy Constructor
        */
        TickerResourceObserver(const TickerResourceObserver &observer);
        
        /**
        Destructor
        */
        virtual ~TickerResourceObserver();
        
        /**
        begin the observation
        */
        virtual void beginObservation();
        
        /**
        stop the observation
        */
        virtual void stopObservation();
                     
        /**
        observation task method
        */
        static void observation_task(void);
        
        /**
        halt the underlying observer mechanism
        */
        virtual void halt();
    
    private:
        Ticker m_ticker;
};

#endif // CONNECTOR_USING_TICKER

#endif // __TICKER_RESOURCE_OBSERVER_H__