Generic SmartRest library
Dependents: SmartRestUnitTest MbedSmartRest MbedSmartRestStreaming
AbstractDataSink.h
00001 /* 00002 * AbstractDataSink.h 00003 * 00004 * Created on: Nov 1, 2013 00005 * * Authors: Vincent Wochnik <v.wochnik@gmail.com> 00006 * 00007 * Copyright (c) 2013 Cumulocity GmbH 00008 * 00009 * Permission is hereby granted, free of charge, to any person obtaining 00010 * a copy of this software and associated documentation files (the 00011 * "Software"), to deal in the Software without restriction, including 00012 * without limitation the rights to use, copy, modify, merge, publish, 00013 * distribute, sublicense, and/or sell copies of the Software, and to 00014 * permit persons to whom the Software is furnished to do so, subject to 00015 * the following conditions: 00016 * 00017 * The above copyright notice and this permission notice shall be 00018 * included in all copies or substantial portions of the Software. 00019 * 00020 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 00021 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 00022 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 00023 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 00024 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 00025 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 00026 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 00027 */ 00028 00029 /** 00030 * @file AbstractDataSink.h 00031 * An abstraction for a data sink which can be used to send data 00032 * over a connection. 00033 * 00034 * Following write actions are supported: 00035 * - write a character 00036 * - write a buffer of certain length 00037 * - write a character string 00038 * - write an unsigned number 00039 */ 00040 00041 #ifndef ABSTRACTDATASINK_H 00042 #define ABSTRACTDATASINK_H 00043 00044 #ifdef HAVE_CONFIG_H 00045 #include <config.h> 00046 #endif 00047 00048 #include <stddef.h> 00049 00050 /* 00051 * The AbstractDataSink class provides a way to write data to a 00052 * connection. 00053 */ 00054 class AbstractDataSink 00055 { 00056 public: 00057 virtual ~AbstractDataSink() { }; 00058 00059 /** 00060 * Writes a single character. 00061 * @param c the character to write 00062 * @return the number of characters written, in this case 1 or 0 00063 */ 00064 virtual size_t write(char c) = 0; 00065 00066 /** 00067 * Writes a buffer. 00068 * @param buf the buffer to write 00069 * @param length the length of the buffer in bytes 00070 * @return the number of characters written 00071 */ 00072 virtual size_t write(void *buf, size_t length) = 0; 00073 00074 /** 00075 * Writes a character string. 00076 * @param str the string to write 00077 * @return the number of characters written 00078 */ 00079 virtual size_t write(const char *str) = 0; 00080 00081 /** 00082 * Writes a number with base 10. 00083 * @param number the number to write 00084 * @return the number of digits written 00085 */ 00086 virtual size_t write(unsigned long number) = 0; 00087 }; 00088 00089 #endif
Generated on Wed Jul 13 2022 09:53:06 by 1.7.2