Cumulocity Official / MbedSmartRest

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

Dependents:   MbedSmartRestMain MbedSmartRestMain

AbstractDataSource.h@11:e1bee9a77652, 2014-11-15 (annotated)

Committer:
Cumulocity
Date:
Sat Nov 15 11:21:01 2014 +0100
Revision:
11:e1bee9a77652
Parent:
0:099f76422485 
Updated from revision ce16ad78546a

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Cumulocity 0:099f76422485 1 /*
Cumulocity 0:099f76422485 2 * AbstractDataSource.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 AbstractDataSource.h
Cumulocity 0:099f76422485 31 * An abstraction layer which provides means to read data from a
Cumulocity 0:099f76422485 32 * connection.
Cumulocity 0:099f76422485 33 *
Cumulocity 0:099f76422485 34 * Example:
Cumulocity 0:099f76422485 35 * @code
Cumulocity 0:099f76422485 36 * AbstractDataSource source;
Cumulocity 0:099f76422485 37 * char c;
Cumulocity 0:099f76422485 38 * while (((c = source.read()) > 0) || (source.status() == DS_STATUS_OK)) {
Cumulocity 0:099f76422485 39 * // read action
Cumulocity 0:099f76422485 40 * }
Cumulocity 0:099f76422485 41 * switch (source.status()) {
Cumulocity 0:099f76422485 42 * case DS_STATUS_OK:
Cumulocity 0:099f76422485 43 * // ok
Cumulocity 0:099f76422485 44 * case DS_STATUS_CLOSED:
Cumulocity 0:099f76422485 45 * // connection closed
Cumulocity 0:099f76422485 46 * case DS_STATUS_TIMEOUT:
Cumulocity 0:099f76422485 47 * // timeout
Cumulocity 0:099f76422485 48 * default:
Cumulocity 0:099f76422485 49 * // other error
Cumulocity 0:099f76422485 50 * }
Cumulocity 0:099f76422485 51 * @encode
Cumulocity 0:099f76422485 52 *
Cumulocity 0:099f76422485 53 */
Cumulocity 0:099f76422485 54
Cumulocity 0:099f76422485 55 #ifndef ABSTRACTDATASOURCE_H
Cumulocity 0:099f76422485 56 #define ABSTRACTDATASOURCE_H
Cumulocity 0:099f76422485 57
Cumulocity 0:099f76422485 58 #include "config.h"
Cumulocity 0:099f76422485 59 #include <stdint.h>
Cumulocity 0:099f76422485 60
Cumulocity 0:099f76422485 61 /** Return value indicating that no error has occurred. */
Cumulocity 0:099f76422485 62 #define DS_STATUS_OK 0
Cumulocity 0:099f76422485 63 /** Return value indicating that the connection has been closed by this
Cumulocity 0:099f76422485 64 * or the foreign host. */
Cumulocity 0:099f76422485 65 #define DS_STATUS_CLOSED 1
Cumulocity 0:099f76422485 66 /** Return value indicating a transmission timeout. */
Cumulocity 0:099f76422485 67 #define DS_STATUS_TIMEOUT 2
Cumulocity 0:099f76422485 68 /** Return value indicating a state error. */
Cumulocity 0:099f76422485 69 #define DS_STATUS_ERROR 3
Cumulocity 0:099f76422485 70
Cumulocity 0:099f76422485 71 /*
Cumulocity 0:099f76422485 72 * The AbstractDataSource class provides a way to read data from a
Cumulocity 0:099f76422485 73 * connection.
Cumulocity 0:099f76422485 74 */
Cumulocity 0:099f76422485 75 class AbstractDataSource
Cumulocity 0:099f76422485 76 {
Cumulocity 11:e1bee9a77652 77 public:
Cumulocity 11:e1bee9a77652 78 virtual ~AbstractDataSource() { };
Cumulocity 0:099f76422485 79
Cumulocity 11:e1bee9a77652 80 /**
Cumulocity 11:e1bee9a77652 81 * Reads one character. When successful, the returned value
Cumulocity 11:e1bee9a77652 82 * represents the character. Otherwise, status() will return a
Cumulocity 11:e1bee9a77652 83 * non-zero value. This function is blocking.
Cumulocity 11:e1bee9a77652 84 * @return the caracter read or zero. If the return value is
Cumulocity 11:e1bee9a77652 85 * non-zero, status() is zero. Otherwise, check status() for a
Cumulocity 11:e1bee9a77652 86 * non-zero value.
Cumulocity 11:e1bee9a77652 87 */
Cumulocity 11:e1bee9a77652 88 virtual char read() = 0;
Cumulocity 0:099f76422485 89
Cumulocity 11:e1bee9a77652 90 /**
Cumulocity 11:e1bee9a77652 91 * Returns the current read state. If a non-zero value is returned,
Cumulocity 11:e1bee9a77652 92 * there is an error. Otherwise, everything is ok.
Cumulocity 11:e1bee9a77652 93 * DS_STATUS_TIMEOUT means that there has been a read timeout.
Cumulocity 11:e1bee9a77652 94 * DS_STATUS_CLOSED means that the connection has been closed
Cumulocity 11:e1bee9a77652 95 * by either this or the foreign host.
Cumulocity 11:e1bee9a77652 96 * @return the status value
Cumulocity 11:e1bee9a77652 97 */
Cumulocity 11:e1bee9a77652 98 virtual uint8_t status() = 0;
Cumulocity 0:099f76422485 99 };
Cumulocity 0:099f76422485 100
Cumulocity 0:099f76422485 101 #endif