mbed.org implementation of the abstract SmartREST library for the Cumulocity Platform SmartREST protocol.
Dependents: MbedSmartRestMain MbedSmartRestMain
AbstractDataSink.h@11:e1bee9a77652, 2014-11-15 (annotated)
- Committer:
- Cumulocity
- Date:
- Sat Nov 15 11:21:01 2014 +0100
- Revision:
- 11:e1bee9a77652
- Parent:
- 5:2b74510900da
Updated from revision ce16ad78546a
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Cumulocity | 0:099f76422485 | 1 | /* |
Cumulocity | 0:099f76422485 | 2 | * AbstractDataSink.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 AbstractDataSink.h |
Cumulocity | 0:099f76422485 | 31 | * An abstraction for a data sink which can be used to send data |
Cumulocity | 0:099f76422485 | 32 | * over a connection. |
Cumulocity | 0:099f76422485 | 33 | * |
Cumulocity | 0:099f76422485 | 34 | * Following write actions are supported: |
Cumulocity | 0:099f76422485 | 35 | * - write a character |
Cumulocity | 0:099f76422485 | 36 | * - write a buffer of certain length |
Cumulocity | 0:099f76422485 | 37 | * - write a character string |
Cumulocity | 0:099f76422485 | 38 | * - write an unsigned number |
Cumulocity | 0:099f76422485 | 39 | */ |
Cumulocity | 0:099f76422485 | 40 | |
Cumulocity | 0:099f76422485 | 41 | #ifndef ABSTRACTDATASINK_H |
Cumulocity | 0:099f76422485 | 42 | #define ABSTRACTDATASINK_H |
Cumulocity | 0:099f76422485 | 43 | |
Cumulocity | 0:099f76422485 | 44 | #include "config.h" |
Cumulocity | 0:099f76422485 | 45 | #include <stddef.h> |
Cumulocity | 0:099f76422485 | 46 | |
Cumulocity | 0:099f76422485 | 47 | /* |
Cumulocity | 0:099f76422485 | 48 | * The AbstractDataSink class provides a way to write data to a |
Cumulocity | 0:099f76422485 | 49 | * connection. |
Cumulocity | 0:099f76422485 | 50 | */ |
Cumulocity | 0:099f76422485 | 51 | class AbstractDataSink |
Cumulocity | 0:099f76422485 | 52 | { |
Cumulocity | 11:e1bee9a77652 | 53 | public: |
Cumulocity | 11:e1bee9a77652 | 54 | virtual ~AbstractDataSink() { }; |
Cumulocity | 0:099f76422485 | 55 | |
Cumulocity | 11:e1bee9a77652 | 56 | /** |
Cumulocity | 11:e1bee9a77652 | 57 | * Writes a single character. |
Cumulocity | 11:e1bee9a77652 | 58 | * @param c the character to write |
Cumulocity | 11:e1bee9a77652 | 59 | * @return the number of characters written, in this case 1 or 0 |
Cumulocity | 11:e1bee9a77652 | 60 | */ |
Cumulocity | 11:e1bee9a77652 | 61 | virtual size_t write(char) = 0; |
Cumulocity | 0:099f76422485 | 62 | |
Cumulocity | 11:e1bee9a77652 | 63 | /** |
Cumulocity | 11:e1bee9a77652 | 64 | * Writes a buffer. |
Cumulocity | 11:e1bee9a77652 | 65 | * @param buf the buffer to write |
Cumulocity | 11:e1bee9a77652 | 66 | * @param length the length of the buffer in bytes |
Cumulocity | 11:e1bee9a77652 | 67 | * @return the number of characters written |
Cumulocity | 11:e1bee9a77652 | 68 | */ |
Cumulocity | 11:e1bee9a77652 | 69 | virtual size_t write(void*, size_t) = 0; |
Cumulocity | 0:099f76422485 | 70 | |
Cumulocity | 11:e1bee9a77652 | 71 | /** |
Cumulocity | 11:e1bee9a77652 | 72 | * Writes a character string. |
Cumulocity | 11:e1bee9a77652 | 73 | * @param str the string to write |
Cumulocity | 11:e1bee9a77652 | 74 | * @return the number of characters written |
Cumulocity | 11:e1bee9a77652 | 75 | */ |
Cumulocity | 11:e1bee9a77652 | 76 | virtual size_t write(const char*) = 0; |
Cumulocity | 0:099f76422485 | 77 | |
Cumulocity | 11:e1bee9a77652 | 78 | /** |
Cumulocity | 11:e1bee9a77652 | 79 | * Writes a number with base 10. |
Cumulocity | 11:e1bee9a77652 | 80 | * @param number the number to write |
Cumulocity | 11:e1bee9a77652 | 81 | * @return the number of digits written |
Cumulocity | 11:e1bee9a77652 | 82 | */ |
Cumulocity | 11:e1bee9a77652 | 83 | virtual size_t write(unsigned long) = 0; |
Cumulocity | 0:099f76422485 | 84 | }; |
Cumulocity | 0:099f76422485 | 85 | |
Cumulocity | 0:099f76422485 | 86 | #endif |