2007-11-15 23:45:00 -05:00
|
|
|
#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".
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2008-06-13 12:02:36 -04:00
|
|
|
#include <stdlib.h>
|
|
|
|
#include <string.h>
|
2007-11-15 23:45:00 -05:00
|
|
|
#include <map>
|
2008-02-05 08:45:04 -05:00
|
|
|
#include <string>
|
2007-12-11 19:54:42 -05:00
|
|
|
#include <iosfwd>
|
2009-05-11 10:30:53 -04:00
|
|
|
#include <stdlib.h>
|
|
|
|
#include <stdint.h>
|
2007-11-15 23:45:00 -05:00
|
|
|
|
2016-01-12 21:10:11 -05:00
|
|
|
#include "util/rsmemory.h"
|
2014-03-17 16:56:06 -04:00
|
|
|
#include "retroshare/rstypes.h"
|
|
|
|
|
2007-11-15 23:45:00 -05:00
|
|
|
/*******************************************************************
|
|
|
|
* 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
|
|
|
|
******************************************************************/
|
|
|
|
|
2011-02-20 16:36:21 -05:00
|
|
|
#include <util/smallobject.h>
|
2011-09-04 16:01:30 -04:00
|
|
|
#include "itempriorities.h"
|
2011-02-20 16:36:21 -05:00
|
|
|
|
2007-12-11 19:54:42 -05:00
|
|
|
const uint8_t RS_PKT_VERSION1 = 0x01;
|
|
|
|
const uint8_t RS_PKT_VERSION_SERVICE = 0x02;
|
2007-11-15 23:45:00 -05:00
|
|
|
|
|
|
|
const uint8_t RS_PKT_CLASS_BASE = 0x01;
|
2007-12-11 19:54:42 -05:00
|
|
|
const uint8_t RS_PKT_CLASS_CONFIG = 0x02;
|
|
|
|
|
|
|
|
const uint8_t RS_PKT_SUBTYPE_DEFAULT = 0x01; /* if only one subtype */
|
2007-11-15 23:45:00 -05:00
|
|
|
|
|
|
|
|
2011-02-20 16:36:21 -05:00
|
|
|
class RsItem: public RsMemoryManagement::SmallObject
|
2007-11-15 23:45:00 -05:00
|
|
|
{
|
|
|
|
public:
|
2011-09-04 16:01:30 -04:00
|
|
|
RsItem(uint32_t t);
|
|
|
|
RsItem(uint8_t ver, uint8_t cls, uint8_t t, uint8_t subtype);
|
2011-02-20 16:36:21 -05:00
|
|
|
#ifdef DO_STATISTICS
|
2011-09-04 16:01:30 -04:00
|
|
|
void *operator new(size_t s) ;
|
|
|
|
void operator delete(void *,size_t s) ;
|
2011-02-20 16:36:21 -05:00
|
|
|
#endif
|
2007-11-15 23:45:00 -05:00
|
|
|
|
2011-09-04 16:01:30 -04:00
|
|
|
virtual ~RsItem();
|
|
|
|
virtual void clear() = 0;
|
|
|
|
virtual std::ostream &print(std::ostream &out, uint16_t indent = 0) = 0;
|
2012-04-13 20:30:23 -04:00
|
|
|
void print_string(std::string &out, uint16_t indent = 0);
|
2007-12-11 19:54:42 -05:00
|
|
|
|
2011-09-04 16:01:30 -04:00
|
|
|
/* source / destination id */
|
2014-03-17 16:56:06 -04:00
|
|
|
const RsPeerId& PeerId() const { return peerId; }
|
|
|
|
void PeerId(const RsPeerId& id) { peerId = id; }
|
2007-11-15 23:45:00 -05:00
|
|
|
|
2011-09-04 16:01:30 -04:00
|
|
|
/* complete id */
|
2013-11-02 10:35:33 -04:00
|
|
|
uint32_t PacketId() const;
|
2007-11-15 23:45:00 -05:00
|
|
|
|
2011-09-04 16:01:30 -04:00
|
|
|
/* id parts */
|
|
|
|
uint8_t PacketVersion();
|
|
|
|
uint8_t PacketClass();
|
|
|
|
uint8_t PacketType();
|
2014-04-18 17:58:14 -04:00
|
|
|
uint8_t PacketSubType() const;
|
2007-11-15 23:45:00 -05:00
|
|
|
|
2011-09-04 16:01:30 -04:00
|
|
|
/* For Service Packets */
|
|
|
|
RsItem(uint8_t ver, uint16_t service, uint8_t subtype);
|
2014-04-18 17:58:14 -04:00
|
|
|
uint16_t PacketService() const; /* combined Packet class/type (mid 16bits) */
|
2014-12-02 08:22:48 -05:00
|
|
|
void setPacketService(uint16_t service);
|
2010-06-16 17:09:58 -04:00
|
|
|
|
2011-09-04 16:01:30 -04:00
|
|
|
inline uint8_t priority_level() const { return _priority_level ;}
|
2015-03-14 10:33:23 -04:00
|
|
|
inline void setPriorityLevel(uint8_t l) { _priority_level = l ;}
|
|
|
|
|
2007-11-15 23:45:00 -05:00
|
|
|
private:
|
2011-09-04 16:01:30 -04:00
|
|
|
uint32_t type;
|
2014-03-17 16:56:06 -04:00
|
|
|
RsPeerId peerId;
|
2011-09-04 16:01:30 -04:00
|
|
|
uint8_t _priority_level ;
|
2007-11-15 23:45:00 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
class RsSerialType
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
RsSerialType(uint32_t t); /* only uses top 24bits */
|
|
|
|
RsSerialType(uint8_t ver, uint8_t cls, uint8_t t);
|
2007-12-11 19:54:42 -05:00
|
|
|
RsSerialType(uint8_t ver, uint16_t service);
|
2007-11-15 23:45:00 -05:00
|
|
|
|
|
|
|
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);
|
|
|
|
|
2013-11-02 10:35:33 -04:00
|
|
|
uint32_t PacketId() const;
|
2007-11-15 23:45:00 -05:00
|
|
|
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);
|
|
|
|
|
2007-12-11 19:54:42 -05:00
|
|
|
uint16_t getRsItemService(uint32_t type);
|
|
|
|
|
|
|
|
/* size constants */
|
|
|
|
uint32_t getRsPktBaseSize();
|
|
|
|
uint32_t getRsPktMaxSize();
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* helper fns for printing */
|
|
|
|
std::ostream &printRsItemBase(std::ostream &o, std::string n, uint16_t i);
|
|
|
|
std::ostream &printRsItemEnd(std::ostream &o, std::string n, uint16_t i);
|
|
|
|
|
|
|
|
/* defined in rstlvtypes.cc - redeclared here for ease */
|
|
|
|
std::ostream &printIndent(std::ostream &out, uint16_t indent);
|
|
|
|
/* Wrapper class for data that is serialised somewhere else */
|
|
|
|
|
|
|
|
class RsRawItem: public RsItem
|
|
|
|
{
|
2016-08-25 09:11:58 -04:00
|
|
|
public:
|
|
|
|
RsRawItem(uint32_t t, uint32_t size) : RsItem(t), len(size)
|
|
|
|
{ data = rs_malloc(len); }
|
|
|
|
virtual ~RsRawItem() { free(data); }
|
2010-06-16 17:09:58 -04:00
|
|
|
|
2016-08-25 09:11:58 -04:00
|
|
|
uint32_t getRawLength() { return len; }
|
|
|
|
void * getRawData() { return data; }
|
2007-11-15 23:45:00 -05:00
|
|
|
|
2016-08-25 09:11:58 -04:00
|
|
|
virtual void clear() {}
|
|
|
|
virtual std::ostream &print(std::ostream &out, uint16_t indent = 0);
|
|
|
|
|
|
|
|
private:
|
|
|
|
void *data;
|
|
|
|
uint32_t len;
|
|
|
|
};
|
2007-11-15 23:45:00 -05:00
|
|
|
|
|
|
|
|
|
|
|
#endif /* RS_BASE_SERIALISER_H */
|