Vincent Wochnik / SmartRest

Generic SmartRest library

Dependents:   SmartRestUnitTest MbedSmartRest MbedSmartRestStreaming

AbstractDataSource.h@0:744801d5734d, 2014-03-24 (annotated)

Committer:
vwochnik
Date:
Mon Mar 24 09:57:40 2014 +0000
Revision:
0:744801d5734d
fix;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vwochnik 0:744801d5734d 1 /*
vwochnik 0:744801d5734d 2 * AbstractDataSource.h
vwochnik 0:744801d5734d 3 *
vwochnik 0:744801d5734d 4 * Created on: Nov 1, 2013
vwochnik 0:744801d5734d 5 * * Authors: Vincent Wochnik <v.wochnik@gmail.com>
vwochnik 0:744801d5734d 6 *
vwochnik 0:744801d5734d 7 * Copyright (c) 2013 Cumulocity GmbH
vwochnik 0:744801d5734d 8 *
vwochnik 0:744801d5734d 9 * Permission is hereby granted, free of charge, to any person obtaining
vwochnik 0:744801d5734d 10 * a copy of this software and associated documentation files (the
vwochnik 0:744801d5734d 11 * "Software"), to deal in the Software without restriction, including
vwochnik 0:744801d5734d 12 * without limitation the rights to use, copy, modify, merge, publish,
vwochnik 0:744801d5734d 13 * distribute, sublicense, and/or sell copies of the Software, and to
vwochnik 0:744801d5734d 14 * permit persons to whom the Software is furnished to do so, subject to
vwochnik 0:744801d5734d 15 * the following conditions:
vwochnik 0:744801d5734d 16 *
vwochnik 0:744801d5734d 17 * The above copyright notice and this permission notice shall be
vwochnik 0:744801d5734d 18 * included in all copies or substantial portions of the Software.
vwochnik 0:744801d5734d 19 *
vwochnik 0:744801d5734d 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
vwochnik 0:744801d5734d 21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
vwochnik 0:744801d5734d 22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
vwochnik 0:744801d5734d 23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
vwochnik 0:744801d5734d 24 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
vwochnik 0:744801d5734d 25 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
vwochnik 0:744801d5734d 26 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
vwochnik 0:744801d5734d 27 */
vwochnik 0:744801d5734d 28
vwochnik 0:744801d5734d 29 /**
vwochnik 0:744801d5734d 30 * @file AbstractDataSource.h
vwochnik 0:744801d5734d 31 * An abstraction layer which provides means to read data from a
vwochnik 0:744801d5734d 32 * connection.
vwochnik 0:744801d5734d 33 *
vwochnik 0:744801d5734d 34 * Example:
vwochnik 0:744801d5734d 35 * @code
vwochnik 0:744801d5734d 36 * AbstractDataSource source;
vwochnik 0:744801d5734d 37 * char c;
vwochnik 0:744801d5734d 38 * while (((c = source.read()) > 0) || (source.status() == DS_STATUS_OK)) {
vwochnik 0:744801d5734d 39 * // read action
vwochnik 0:744801d5734d 40 * }
vwochnik 0:744801d5734d 41 * switch (source.status()) {
vwochnik 0:744801d5734d 42 * case DS_STATUS_OK:
vwochnik 0:744801d5734d 43 * // ok
vwochnik 0:744801d5734d 44 * case DS_STATUS_CLOSED:
vwochnik 0:744801d5734d 45 * // connection closed
vwochnik 0:744801d5734d 46 * case DS_STATUS_TIMEOUT:
vwochnik 0:744801d5734d 47 * // timeout
vwochnik 0:744801d5734d 48 * default:
vwochnik 0:744801d5734d 49 * // other error
vwochnik 0:744801d5734d 50 * }
vwochnik 0:744801d5734d 51 * @encode
vwochnik 0:744801d5734d 52 *
vwochnik 0:744801d5734d 53 */
vwochnik 0:744801d5734d 54
vwochnik 0:744801d5734d 55 #ifndef ABSTRACTDATASOURCE_H
vwochnik 0:744801d5734d 56 #define ABSTRACTDATASOURCE_H
vwochnik 0:744801d5734d 57
vwochnik 0:744801d5734d 58 #ifdef HAVE_CONFIG_H
vwochnik 0:744801d5734d 59 #include <config.h>
vwochnik 0:744801d5734d 60 #endif
vwochnik 0:744801d5734d 61
vwochnik 0:744801d5734d 62 #include <stdint.h>
vwochnik 0:744801d5734d 63
vwochnik 0:744801d5734d 64 /** Return value indicating that no error has occurred. */
vwochnik 0:744801d5734d 65 #define DS_STATUS_OK 0
vwochnik 0:744801d5734d 66 /** Return value indicating that the connection has been closed by this
vwochnik 0:744801d5734d 67 * or the foreign host. */
vwochnik 0:744801d5734d 68 #define DS_STATUS_CLOSED 1
vwochnik 0:744801d5734d 69 /** Return value indicating a transmission timeout. */
vwochnik 0:744801d5734d 70 #define DS_STATUS_TIMEOUT 2
vwochnik 0:744801d5734d 71 /** Return value indicating a state error. */
vwochnik 0:744801d5734d 72 #define DS_STATUS_ERROR 3
vwochnik 0:744801d5734d 73
vwochnik 0:744801d5734d 74 /*
vwochnik 0:744801d5734d 75 * The AbstractDataSource class provides a way to read data from a
vwochnik 0:744801d5734d 76 * connection.
vwochnik 0:744801d5734d 77 */
vwochnik 0:744801d5734d 78 class AbstractDataSource
vwochnik 0:744801d5734d 79 {
vwochnik 0:744801d5734d 80 public:
vwochnik 0:744801d5734d 81 virtual ~AbstractDataSource() { };
vwochnik 0:744801d5734d 82
vwochnik 0:744801d5734d 83 /**
vwochnik 0:744801d5734d 84 * Reads one character. When successful, the returned value
vwochnik 0:744801d5734d 85 * represents the character. Otherwise, status() will return a
vwochnik 0:744801d5734d 86 * non-zero value. This function is blocking.
vwochnik 0:744801d5734d 87 * @return the caracter read or zero. If the return value is
vwochnik 0:744801d5734d 88 * non-zero, status() is zero. Otherwise, check status() for a
vwochnik 0:744801d5734d 89 * non-zero value.
vwochnik 0:744801d5734d 90 */
vwochnik 0:744801d5734d 91 virtual char read() = 0;
vwochnik 0:744801d5734d 92
vwochnik 0:744801d5734d 93 /**
vwochnik 0:744801d5734d 94 * Returns the current read state. If a non-zero value is returned,
vwochnik 0:744801d5734d 95 * there is an error. Otherwise, everything is ok.
vwochnik 0:744801d5734d 96 * DS_STATUS_TIMEOUT means that there has been a read timeout.
vwochnik 0:744801d5734d 97 * DS_STATUS_CLOSED means that the connection has been closed
vwochnik 0:744801d5734d 98 * by either this or the foreign host.
vwochnik 0:744801d5734d 99 * @return the status value
vwochnik 0:744801d5734d 100 */
vwochnik 0:744801d5734d 101 virtual uint8_t status() = 0;
vwochnik 0:744801d5734d 102 };
vwochnik 0:744801d5734d 103
vwochnik 0:744801d5734d 104 #endif