m2mreportobserver.h

00001 /*
00002  * Copyright (c) 2015 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef M2MREPORTOBSERVER_H
00017 #define M2MREPORTOBSERVER_H
00018 
00019 #include <inttypes.h>
00020 #include <mbed-client/m2mvector.h>
00021 
00022 /*! \file m2mreportobserver.h
00023  * \brief M2MReportObserver.
00024  * An interface for inviting the base class
00025  * to send a report to the server.
00026  *
00027  */
00028 class M2MReportObserver
00029 {
00030   public:
00031 
00032     /**
00033      * \brief An observation callback to be sent to the
00034      * server due to a change in the observed parameter.
00035      * \param changed_instance_ids A list of changed object instance IDs.
00036      * \param obs_number The observation number.
00037      * \param send_object Indicates whether the whole object will be sent or not.
00038      *
00039      * \return True if the message was send, False if there is already ongoing notification.
00040      */
00041     virtual bool observation_to_be_sent(const m2m::Vector<uint16_t> &changed_instance_ids,
00042                                         uint16_t obs_number,
00043                                         bool send_object = false) = 0;
00044 
00045 };
00046 
00047 #endif // M2MREPORTOBSERVER_H