mbed.org implementation of the abstract SmartREST library for the Cumulocity Platform SmartREST protocol.
Dependents: MbedSmartRestMain MbedSmartRestMain
SmartRest.h@10:97077cfa13fc, 2014-10-23 (annotated)
- Committer:
- Cumulocity
- Date:
- Thu Oct 23 14:41:58 2014 +0200
- Revision:
- 10:97077cfa13fc
- Parent:
- 7:8159a2d12e4e
- Child:
- 11:e1bee9a77652
Updated from revision 207c030e9657
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Cumulocity | 0:099f76422485 | 1 | /* |
Cumulocity | 0:099f76422485 | 2 | * SmartRest.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 | /** |
Cumulocity | 0:099f76422485 | 30 | * @file SmartRest.h |
Cumulocity | 0:099f76422485 | 31 | * The main SmartRest facade class. This class is abstract, because the |
Cumulocity | 0:099f76422485 | 32 | * actual implementation has to supply a client. |
Cumulocity | 0:099f76422485 | 33 | */ |
Cumulocity | 0:099f76422485 | 34 | |
Cumulocity | 0:099f76422485 | 35 | #ifndef SMARTREST_H |
Cumulocity | 0:099f76422485 | 36 | #define SMARTREST_H |
Cumulocity | 0:099f76422485 | 37 | |
Cumulocity | 0:099f76422485 | 38 | #include "config.h" |
Cumulocity | 0:099f76422485 | 39 | #include <stddef.h> |
Cumulocity | 0:099f76422485 | 40 | #include <stdint.h> |
Cumulocity | 6:cd7ba1ddb664 | 41 | #include "AbstractSmartRest.h" |
Cumulocity | 0:099f76422485 | 42 | #include "AbstractClient.h" |
Cumulocity | 0:099f76422485 | 43 | #include "Parser.h" |
Cumulocity | 0:099f76422485 | 44 | |
Cumulocity | 0:099f76422485 | 45 | /** |
Cumulocity | 6:cd7ba1ddb664 | 46 | * The main SmartRest client implementation. |
Cumulocity | 0:099f76422485 | 47 | */ |
Cumulocity | 6:cd7ba1ddb664 | 48 | class SmartRest : public AbstractSmartRest |
Cumulocity | 0:099f76422485 | 49 | { |
Cumulocity | 6:cd7ba1ddb664 | 50 | public: |
Cumulocity | 0:099f76422485 | 51 | /** |
Cumulocity | 1:9a11a331e340 | 52 | * Creates a new generic SmartRest object. |
Cumulocity | 0:099f76422485 | 53 | * @param client the abstract client to use |
Cumulocity | 0:099f76422485 | 54 | * @param identifier the device identifier |
Cumulocity | 0:099f76422485 | 55 | */ |
Cumulocity | 0:099f76422485 | 56 | SmartRest(AbstractClient&, const char*); |
Cumulocity | 0:099f76422485 | 57 | |
Cumulocity | 2:45a6e44a4fb4 | 58 | uint8_t setAuthorization(const char*, const char*); |
Cumulocity | 5:2b74510900da | 59 | #ifdef SMARTREST_TRANSACTIONAL |
Cumulocity | 5:2b74510900da | 60 | uint8_t request(const DataGenerator&, const char* = NULL); |
Cumulocity | 5:2b74510900da | 61 | uint8_t request(const DataGenerator&, Aggregator&, const char* = NULL); |
Cumulocity | 5:2b74510900da | 62 | #endif |
Cumulocity | 5:2b74510900da | 63 | uint8_t bootstrap(const DataGenerator&); |
Cumulocity | 5:2b74510900da | 64 | #ifndef SMARTREST_TRANSACTIONAL |
Cumulocity | 5:2b74510900da | 65 | uint8_t send(const DataGenerator&, const char* = NULL); |
Cumulocity | 2:45a6e44a4fb4 | 66 | uint8_t receive(ParsedRecord&); |
Cumulocity | 0:099f76422485 | 67 | void stop(); |
Cumulocity | 5:2b74510900da | 68 | #endif |
Cumulocity | 10:97077cfa13fc | 69 | const char * getIdentifier(); |
Cumulocity | 0:099f76422485 | 70 | |
Cumulocity | 0:099f76422485 | 71 | protected: |
Cumulocity | 5:2b74510900da | 72 | #ifdef SMARTREST_TRANSACTIONAL |
Cumulocity | 5:2b74510900da | 73 | uint8_t send(const DataGenerator&, const char*); |
Cumulocity | 5:2b74510900da | 74 | uint8_t receive(ParsedRecord&); |
Cumulocity | 5:2b74510900da | 75 | void stop(); |
Cumulocity | 5:2b74510900da | 76 | #endif |
Cumulocity | 1:9a11a331e340 | 77 | uint8_t beginRequest(const char*); |
Cumulocity | 0:099f76422485 | 78 | uint8_t awaitResponse(); |
Cumulocity | 0:099f76422485 | 79 | bool setMoGid(ParsedRecord&); |
Cumulocity | 0:099f76422485 | 80 | |
Cumulocity | 0:099f76422485 | 81 | private: |
Cumulocity | 0:099f76422485 | 82 | AbstractClient& _client; |
Cumulocity | 0:099f76422485 | 83 | AbstractDataSource *_source; |
Cumulocity | 0:099f76422485 | 84 | Parser _parser; |
Cumulocity | 0:099f76422485 | 85 | const char *_identifier; |
Cumulocity | 0:099f76422485 | 86 | char _mogid[8 * sizeof(long) + 1]; |
Cumulocity | 0:099f76422485 | 87 | }; |
Cumulocity | 0:099f76422485 | 88 | |
Cumulocity | 0:099f76422485 | 89 | #endif |