mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-02-18 05:44:14 -05:00
a89e5a4784
Addition of the new serialiser (the start anyway). Addition of regression test system. git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@249 b45a01b8-16f6-495d-af2f-9b41ad6348cc
134 lines
3.3 KiB
C++
134 lines
3.3 KiB
C++
#ifndef RS_BASE_SERIALISER_H
|
|
#define RS_BASE_SERIALISER_H
|
|
|
|
/*
|
|
* libretroshare/src/serialiser: rsserial.h
|
|
*
|
|
* RetroShare Serialiser.
|
|
*
|
|
* Copyright 2007-2008 by Robert Fernie.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License Version 2 as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
* USA.
|
|
*
|
|
* Please report all bugs and problems to "retroshare@lunamutt.com".
|
|
*
|
|
*/
|
|
|
|
#include <map>
|
|
|
|
|
|
/*******************************************************************
|
|
* This is the Top-Level serialiser/deserialise,
|
|
*
|
|
* Data is Serialised into the following format
|
|
*
|
|
* -----------------------------------------
|
|
* | TYPE (4 bytes) | Size (4 bytes) |
|
|
* -----------------------------------------
|
|
* | |
|
|
* | Data .... |
|
|
* | |
|
|
* -----------------------------------------
|
|
*
|
|
* Size is the total size of the packet (including the 8 byte header)
|
|
* Type is composed of:
|
|
*
|
|
* 8 bits: Version (0x01)
|
|
* 8 bits: Class
|
|
* 8 bits: Type
|
|
* 8 bits: SubType
|
|
******************************************************************/
|
|
|
|
const uint8_t RS_PKT_VERSION1 = 0x01;
|
|
|
|
const uint8_t RS_PKT_CLASS_BASE = 0x01;
|
|
const uint8_t RS_PKT_CLASS_SERVICE = 0x02;
|
|
const uint8_t RS_PKT_CLASS_SERV_INIT = 0x03;
|
|
const uint8_t RS_PKT_CLASS_CONFIG = 0x11;
|
|
|
|
|
|
class RsItem
|
|
{
|
|
public:
|
|
RsItem(uint32_t t);
|
|
RsItem(uint8_t ver, uint8_t cls, uint8_t t, uint8_t subtype);
|
|
|
|
virtual ~RsItem();
|
|
virtual void clear() = 0;
|
|
|
|
/* complete id */
|
|
uint32_t PacketId();
|
|
|
|
/* id parts */
|
|
uint8_t PacketVersion();
|
|
uint8_t PacketClass();
|
|
uint8_t PacketType();
|
|
uint8_t PacketSubType();
|
|
|
|
private:
|
|
uint32_t type;
|
|
};
|
|
|
|
|
|
class RsSerialType
|
|
{
|
|
public:
|
|
RsSerialType(uint32_t t); /* only uses top 24bits */
|
|
RsSerialType(uint8_t ver, uint8_t cls, uint8_t t);
|
|
|
|
virtual ~RsSerialType();
|
|
|
|
virtual uint32_t size(RsItem *);
|
|
virtual bool serialise (RsItem *item, void *data, uint32_t *size);
|
|
virtual RsItem * deserialise(void *data, uint32_t *size);
|
|
|
|
uint32_t PacketId();
|
|
private:
|
|
uint32_t type;
|
|
};
|
|
|
|
|
|
class RsSerialiser
|
|
{
|
|
public:
|
|
RsSerialiser();
|
|
~RsSerialiser();
|
|
bool addSerialType(RsSerialType *type);
|
|
|
|
uint32_t size(RsItem *);
|
|
bool serialise (RsItem *item, void *data, uint32_t *size);
|
|
RsItem * deserialise(void *data, uint32_t *size);
|
|
|
|
|
|
private:
|
|
std::map<uint32_t, RsSerialType *> serialisers;
|
|
};
|
|
|
|
bool setRsItemHeader(void *data, uint32_t size, uint32_t type, uint32_t pktsize);
|
|
|
|
/* Extract Header Information from Packet */
|
|
uint32_t getRsItemId(void *data);
|
|
uint32_t getRsItemSize(void *data);
|
|
|
|
uint8_t getRsItemVersion(uint32_t type);
|
|
uint8_t getRsItemClass(uint32_t type);
|
|
uint8_t getRsItemType(uint32_t type);
|
|
uint8_t getRsItemSubType(uint32_t type);
|
|
|
|
|
|
|
|
|
|
#endif /* RS_BASE_SERIALISER_H */
|