StaticData.h

00001 /*
00002  * StaticData.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 #ifndef STATICDATA_H
00030 #define STATICDATA_H
00031 
00032 #include "config.h"
00033 #include <stddef.h>
00034 #include "DataGenerator.h"
00035 
00036 /*
00037  * A static data store mechanism streaming data to a sink.
00038  * 
00039  * Example:
00040  * @code
00041  * // given a concrete data sink
00042  * AbstractDataSink sink;
00043 
00044  * StaticData data("Hello World!");
00045  * assert(data.writtenLength() == data.writeTo(sink));
00046  * @encode
00047  */
00048 class StaticData : public DataGenerator
00049 {
00050     public:
00051         StaticData(void*, size_t, bool = false);
00052         StaticData(const char*, bool = false);
00053         ~StaticData();
00054         size_t writeTo(AbstractDataSink&) const;
00055         size_t writtenLength() const;
00056         DataGenerator* copy() const;
00057 
00058     private:
00059         void *_buf;
00060         size_t _len;
00061         bool _alloc;
00062 };
00063 
00064 #endif