Cumulocity Official / MbedSmartRest

mbed.org implementation of the abstract SmartREST library for the Cumulocity Platform SmartREST protocol.

Dependents:   MbedSmartRestMain MbedSmartRestMain

Aggregator.h@0:099f76422485, 2014-07-03 (annotated)

Committer:
Cumulocity
Date:
Thu Jul 03 20:38:04 2014 +0200
Revision:
0:099f76422485
Child:
5:2b74510900da
Updated from revision 0413a0179eb6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Cumulocity 0:099f76422485 1 /*
Cumulocity 0:099f76422485 2 * Aggregator.h
Cumulocity 0:099f76422485 3 *
Cumulocity 0:099f76422485 4 * Created on: Nov 1, 2013
Cumulocity 0:099f76422485 5 * * Authors: Vincent Wochnik <v.wochnik@gmail.com>
Cumulocity 0:099f76422485 6 *
Cumulocity 0:099f76422485 7 * Copyright (c) 2013 Cumulocity GmbH
Cumulocity 0:099f76422485 8 *
Cumulocity 0:099f76422485 9 * Permission is hereby granted, free of charge, to any person obtaining
Cumulocity 0:099f76422485 10 * a copy of this software and associated documentation files (the
Cumulocity 0:099f76422485 11 * "Software"), to deal in the Software without restriction, including
Cumulocity 0:099f76422485 12 * without limitation the rights to use, copy, modify, merge, publish,
Cumulocity 0:099f76422485 13 * distribute, sublicense, and/or sell copies of the Software, and to
Cumulocity 0:099f76422485 14 * permit persons to whom the Software is furnished to do so, subject to
Cumulocity 0:099f76422485 15 * the following conditions:
Cumulocity 0:099f76422485 16 *
Cumulocity 0:099f76422485 17 * The above copyright notice and this permission notice shall be
Cumulocity 0:099f76422485 18 * included in all copies or substantial portions of the Software.
Cumulocity 0:099f76422485 19 *
Cumulocity 0:099f76422485 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Cumulocity 0:099f76422485 21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Cumulocity 0:099f76422485 22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Cumulocity 0:099f76422485 23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
Cumulocity 0:099f76422485 24 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
Cumulocity 0:099f76422485 25 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Cumulocity 0:099f76422485 26 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Cumulocity 0:099f76422485 27 */
Cumulocity 0:099f76422485 28
Cumulocity 0:099f76422485 29 #ifndef AGGREGATOR_H
Cumulocity 0:099f76422485 30 #define AGGREGATOR_H
Cumulocity 0:099f76422485 31
Cumulocity 0:099f76422485 32 #include "config.h"
Cumulocity 0:099f76422485 33 #include <stddef.h>
Cumulocity 0:099f76422485 34 #include "DataGenerator.h"
Cumulocity 0:099f76422485 35
Cumulocity 0:099f76422485 36 #ifndef SMARTREST_AGGREGATOR_INITIAL_CAPACITY
Cumulocity 0:099f76422485 37 #define SMARTREST_AGGREGATOR_INITIAL_CAPACITY 50
Cumulocity 0:099f76422485 38 #endif
Cumulocity 0:099f76422485 39 #ifndef SMARTREST_AGGREGATOR_MEMORY_INCREMENT
Cumulocity 0:099f76422485 40 #define SMARTREST_AGGREGATOR_MEMORY_INCREMENT 25
Cumulocity 0:099f76422485 41 #endif
Cumulocity 0:099f76422485 42 //#define SMARTREST_AGGREGATOR_FIXED_SIZE 100
Cumulocity 0:099f76422485 43
Cumulocity 0:099f76422485 44 /**
Cumulocity 0:099f76422485 45 * An aggregator of data generators. This class can aggregate instances of
Cumulocity 0:099f76422485 46 * itself.
Cumulocity 0:099f76422485 47 * If the aggregator is set to copying all added data generators using
Cumulocity 0:099f76422485 48 * the copy() method, all objects are being properly deallocated on
Cumulocity 0:099f76422485 49 * destruction.
Cumulocity 0:099f76422485 50 *
Cumulocity 0:099f76422485 51 * Example:
Cumulocity 0:099f76422485 52 * @code
Cumulocity 0:099f76422485 53 * // Given: A concrete SmartRest implementation.
Cumulocity 0:099f76422485 54 * SmartRest client;
Cumulocity 0:099f76422485 55 *
Cumulocity 0:099f76422485 56 * // sets up a growing aggregator which copies all added objects
Cumulocity 0:099f76422485 57 * // to the heap
Cumulocity 0:099f76422485 58 * Aggregator buffer(25, true, true);
Cumulocity 0:099f76422485 59 *
Cumulocity 0:099f76422485 60 * // random data collection
Cumulocity 0:099f76422485 61 * for (uint8_t i = 0; i < 32; ++i) {
Cumulocity 0:099f76422485 62 * // Note: ComposedRecord is not copying any values into the heap
Cumulocity 0:099f76422485 63 * // because the availability of its values in guaranteed during the
Cumulocity 0:099f76422485 64 * // instance's lifetime.
Cumulocity 0:099f76422485 65 * ComposedRecord record(false);
Cumulocity 0:099f76422485 66 *
Cumulocity 0:099f76422485 67 * CharValue msgId(100);
Cumulocity 0:099f76422485 68 * IntegerValue number(i);
Cumulocity 0:099f76422485 69 * record.add(msgId).add(number);
Cumulocity 0:099f76422485 70 *
Cumulocity 0:099f76422485 71 * // Note: ComposedRecord is now cloned into the heap to extend its
Cumulocity 0:099f76422485 72 * // lifetime beyond this code block.
Cumulocity 0:099f76422485 73 * buffer.add(record);
Cumulocity 0:099f76422485 74 * }
Cumulocity 0:099f76422485 75 *
Cumulocity 0:099f76422485 76 * // send the bulk request
Cumulocity 0:099f76422485 77 * uint8_t ret = client.send(buffer);
Cumulocity 0:099f76422485 78 * if (ret != SMARTREST_SUCCESS) {
Cumulocity 0:099f76422485 79 * // error handling
Cumulocity 0:099f76422485 80 * }
Cumulocity 0:099f76422485 81 * @encode
Cumulocity 0:099f76422485 82 */
Cumulocity 0:099f76422485 83 class Aggregator : public DataGenerator
Cumulocity 0:099f76422485 84 {
Cumulocity 0:099f76422485 85 public:
Cumulocity 0:099f76422485 86 #ifndef SMARTREST_AGGREGATOR_FIXED_SIZE
Cumulocity 0:099f76422485 87 /**
Cumulocity 0:099f76422485 88 * Creates a new Aggregator instance.
Cumulocity 0:099f76422485 89 * @param capacity the initial capacity of the instance
Cumulocity 0:099f76422485 90 * @param growing specifies the capability of this instance to grow
Cumulocity 0:099f76422485 91 * @param copy specifies whether all added data generators shall be
Cumulocity 0:099f76422485 92 * copied using the copy() method
Cumulocity 0:099f76422485 93 */
Cumulocity 0:099f76422485 94 Aggregator(size_t=SMARTREST_AGGREGATOR_INITIAL_CAPACITY, bool=true, bool=false);
Cumulocity 0:099f76422485 95 #else
Cumulocity 0:099f76422485 96 /**
Cumulocity 0:099f76422485 97 * Creates a new Aggregator instance.
Cumulocity 0:099f76422485 98 * @param copy specifies whether all added data generators shall be
Cumulocity 0:099f76422485 99 * copied using the copy() method
Cumulocity 0:099f76422485 100 */
Cumulocity 0:099f76422485 101 Aggregator(bool=false);
Cumulocity 0:099f76422485 102 #endif
Cumulocity 0:099f76422485 103 ~Aggregator();
Cumulocity 0:099f76422485 104
Cumulocity 0:099f76422485 105 /**
Cumulocity 0:099f76422485 106 * Adds a data generator to the aggregator.
Cumulocity 0:099f76422485 107 * @param generator the data generator to add
Cumulocity 0:099f76422485 108 * @return true if added, false otherwise.
Cumulocity 0:099f76422485 109 */
Cumulocity 0:099f76422485 110 bool add(const DataGenerator&);
Cumulocity 0:099f76422485 111
Cumulocity 0:099f76422485 112 /**
Cumulocity 0:099f76422485 113 * Clears the aggregator. The capacity will shrink to it's initial
Cumulocity 0:099f76422485 114 * size.
Cumulocity 0:099f76422485 115 */
Cumulocity 0:099f76422485 116 void clear();
Cumulocity 0:099f76422485 117
Cumulocity 0:099f76422485 118 /**
Cumulocity 0:099f76422485 119 * Returns the number of data generators aggregated by this instance.
Cumulocity 0:099f76422485 120 * @return the number of data generators aggregated
Cumulocity 0:099f76422485 121 */
Cumulocity 0:099f76422485 122 size_t length();
Cumulocity 0:099f76422485 123
Cumulocity 0:099f76422485 124 /**
Cumulocity 0:099f76422485 125 * Returns whether the aggregator is full. If growing, this will
Cumulocity 0:099f76422485 126 * always return false.
Cumulocity 0:099f76422485 127 * @return whether the aggregator is full
Cumulocity 0:099f76422485 128 */
Cumulocity 0:099f76422485 129 bool full();
Cumulocity 0:099f76422485 130
Cumulocity 0:099f76422485 131 /**
Cumulocity 0:099f76422485 132 * Returns the capacity of the aggregator. This will always return zero
Cumulocity 0:099f76422485 133 * if the aggregator is growing.
Cumulocity 0:099f76422485 134 */
Cumulocity 0:099f76422485 135 size_t capacity();
Cumulocity 0:099f76422485 136
Cumulocity 0:099f76422485 137 size_t writeTo(AbstractDataSink&) const;
Cumulocity 0:099f76422485 138 size_t writtenLength() const;
Cumulocity 0:099f76422485 139 DataGenerator* copy() const;
Cumulocity 0:099f76422485 140
Cumulocity 0:099f76422485 141 private:
Cumulocity 0:099f76422485 142 #ifdef SMARTREST_AGGREGATOR_FIXED_SIZE
Cumulocity 0:099f76422485 143 const DataGenerator *_list[SMARTREST_AGGREGATOR_FIXED_SIZE];
Cumulocity 0:099f76422485 144 #else
Cumulocity 0:099f76422485 145 const DataGenerator **_list;
Cumulocity 0:099f76422485 146 #endif
Cumulocity 0:099f76422485 147 size_t _length;
Cumulocity 0:099f76422485 148 bool _alloc;
Cumulocity 0:099f76422485 149 #ifndef SMARTREST_AGGREGATOR_FIXED_SIZE
Cumulocity 0:099f76422485 150 size_t _capacity, _initial;
Cumulocity 0:099f76422485 151 bool _growing;
Cumulocity 0:099f76422485 152 #endif
Cumulocity 0:099f76422485 153 };
Cumulocity 0:099f76422485 154
Cumulocity 0:099f76422485 155 #endif