/***************************************************************************
 * Copyright (C) gempa GmbH                                                *
 * All rights reserved.                                                    *
 * Contact: gempa GmbH (seiscomp-dev@gempa.de)                             *
 *                                                                         *
 * GNU Affero General Public License Usage                                 *
 * This file may be used under the terms of the GNU Affero                 *
 * Public License version 3.0 as published by the Free Software Foundation *
 * and appearing in the file LICENSE included in the packaging of this     *
 * file. Please review the following information to ensure the GNU Affero  *
 * Public License version 3.0 requirements will be met:                    *
 * https://www.gnu.org/licenses/agpl-3.0.html.                             *
 *                                                                         *
 * Other Usage                                                             *
 * Alternatively, this file may be used in accordance with the terms and   *
 * conditions contained in a signed written agreement between you and      *
 * gempa GmbH.                                                             *
 ***************************************************************************/


#ifndef SEISCOMP_WIRED_BUFFER_H
#define SEISCOMP_WIRED_BUFFER_H


#include <seiscomp/core/baseobject.h>
#include <seiscomp/core/datetime.h>
#include <string>
#include <list>


namespace Seiscomp {
namespace Wired {


DEFINE_SMARTPOINTER(Buffer);

typedef std::list<BufferPtr> BufferList;

struct SC_SYSTEM_CORE_API Buffer : Seiscomp::Core::BaseObject {
	Buffer(int max_size = 0x7fffffff)
	: encoding(Identity), format(Plain), lock(false),
	  maxBufferSize(max_size), lastModified(0) {}

	~Buffer() override {}

	enum Encoding {
		Identity,
		Compress,
		GZip,
		BZip2
	};

	enum Format {
		Plain,
		XML,
		JSON,
		BSON,
		Octetts,
		Custom
	};

	Seiscomp::Core::Time timestamp;
	Encoding             encoding;
	Format               format;
	bool                 lock;
	std::string          header;
	std::string          data;
	//! Maximum size of one buffer chunk when update is called
	int                  maxBufferSize;
	time_t               lastModified;

	// If true is returned the buffer is valid and updated
	// otherwise everything has been read
	virtual bool updateBuffer();
	virtual size_t length() const;
};


}
}


#endif