]> git.tdb.fi Git - libs/net.git/blobdiff - source/net/protocol.h
Add a dynamic receiver class for more flexible packet handling
[libs/net.git] / source / net / protocol.h
index 7ff63cb1e7dd12cc2a8fb3e9ba1e092062bcc754..5051338f3911558c8e2ee19fe2d0665c0e10eec3 100644 (file)
@@ -1,87 +1,74 @@
 #ifndef MSP_NET_PROTOCOL_H_
 #define MSP_NET_PROTOCOL_H_
 
+#include <cstdint>
 #include <map>
+#include <memory>
 #include <stdexcept>
 #include <vector>
-#include <msp/core/inttypes.h>
+#include <msp/core/hash.h>
+#include "mspnet_api.h"
 #include "receiver.h"
 
 namespace Msp {
 namespace Net {
 
-class bad_packet: public std::runtime_error
+class MSPNET_API bad_packet: public std::runtime_error
 {
 public:
        bad_packet(const std::string &w): std::runtime_error(w) { }
-       virtual ~bad_packet() throw() { }
 };
 
 
-class buffer_error: public std::runtime_error
+class MSPNET_API buffer_error: public std::runtime_error
 {
 public:
        buffer_error(const std::string &w): std::runtime_error(w) { }
-       virtual ~buffer_error() throw() { }
 };
 
 
-class Protocol
+class MSPNET_API Protocol
 {
+public:
+       struct PacketHeader
+       {
+               std::uint16_t type = 0;
+               std::uint16_t length = 0;
+
+               PacketHeader() = default;
+               PacketHeader(std::uint16_t, std::uint16_t);
+       };
+
 private:
-       template<typename T, UInt8 K>
+       template<typename T, std::uint8_t K>
        struct BasicTraits;
 
        template<typename T>
        struct Traits;
 
        template<typename C>
-       struct CompoundTypeDef
-       {
-               virtual ~CompoundTypeDef() { }
-
-               virtual std::string describe() const = 0;
-               virtual char *serialize(const C &, char *, char *) const = 0;
-               virtual const char *deserialize(C &, const char *, const char *) const = 0;
-       };
-
-       template<typename C, typename S>
-       struct CompoundDef: public CompoundTypeDef<C>
-       {
-               S serializer;
-
-               CompoundDef(const S &);
-
-               virtual std::string describe() const;
-               virtual char *serialize(const C &, char *, char *) const;
-               virtual const char *deserialize(C &, const char *, const char *) const;
-       };
+       class Serializer;
 
        template<typename T>
        class BasicSerializer
        {
        public:
-               typedef T ValueType;
-
                BasicSerializer(const Protocol &) { }
 
-               std::string describe() const { return get_type_signature<T>(); }
+               std::uint64_t get_hash() const { return Traits<T>::signature; }
                char *serialize(const T &, char *, char *) const;
                const char *deserialize(T &, const char *, const char *) const;
        };
 
        class StringSerializer
        {
-       public:
-               typedef std::string ValueType;
-
        private:
-               BasicSerializer<UInt16> length_serializer;
+               BasicSerializer<std::uint16_t> length_serializer;
 
        public:
                StringSerializer(const Protocol &);
 
-               std::string describe() const { return get_type_signature<std::string>(); }
+               std::uint64_t get_hash() const;
                char *serialize(const std::string &, char *, char *) const;
                const char *deserialize(std::string &, const char *, const char *) const;
        };
@@ -89,17 +76,14 @@ private:
        template<typename A>
        class ArraySerializer
        {
-       public:
-               typedef A ValueType;
-
        private:
-               BasicSerializer<UInt16> length_serializer;
+               BasicSerializer<std::uint16_t> length_serializer;
                typename Traits<typename A::value_type>::Serializer element_serializer;
 
        public:
                ArraySerializer(const Protocol &);
 
-               std::string describe() const;
+               std::uint64_t get_hash() const;
                char *serialize(const A &, char *, char *) const;
                const char *deserialize(A &, const char *, const char *) const;
        };
@@ -107,57 +91,48 @@ private:
        template<typename C>
        class CompoundSerializer
        {
-       public:
-               typedef C ValueType;
-
        private:
-               const CompoundTypeDef<C> &def;
+               const Serializer<C> &serializer;
 
        public:
                CompoundSerializer(const Protocol &);
 
-               std::string describe() const { return def.describe(); }
+               std::uint64_t get_hash() const;
                char *serialize(const C &, char *, char *) const;
                const char *deserialize(C &, const char *, const char *) const;
        };
 
-       template<typename P, typename Head, typename S>
-       class Serializer: public Head
+       template<typename C, typename Head, typename T>
+       class FieldSerializer: public Head
        {
        public:
                template<typename N>
-               struct Next
-               {
-                       typedef Serializer<P, Serializer<P, Head, S>, typename Traits<N>::Serializer> Type;
-               };
+               using Next = FieldSerializer<C, FieldSerializer<C, Head, T>, N>;
 
        private:
-               typedef typename S::ValueType P::*Pointer;
-
-               Pointer ptr;
-               S ser;
+               T C::*ptr;
+               typename Traits<T>::Serializer ser;
 
        public:
-               Serializer(const Head &, Pointer, const Protocol &);
+               FieldSerializer(const Head &, T C::*, const Protocol &);
 
-               std::string describe() const;
-               char *serialize(const P &, char *, char *) const;
-               const char *deserialize(P &, const char *, const char *) const;
+               std::uint64_t get_hash() const;
+               char *serialize(const C &, char *, char *) const;
+               const char *deserialize(C &, const char *, const char *) const;
        };
 
-       template<typename P>
-       class NullSerializer
+       template<typename C>
+       class Serializer
        {
        public:
                template<typename N>
-               struct Next
-               {
-                       typedef Serializer<P, NullSerializer, typename Traits<N>::Serializer> Type;
-               };
-
-               std::string describe() const { return std::string(); }
-               char *serialize(const P &, char *b, char *) const { return b; }
-               const char *deserialize(P &, const char *b, const char *) const { return b; }
+               using Next = FieldSerializer<C, Serializer<C>, N>;
+
+               virtual ~Serializer() = default;
+
+               virtual std::uint64_t get_hash() const { return 0; }
+               virtual char *serialize(const C &, char *b, char *) const { return b; }
+               virtual const char *deserialize(C &, const char *b, const char *) const { return b; }
        };
 
        class PacketDefBase
@@ -165,14 +140,14 @@ private:
        protected:
                unsigned id;
 
-               static unsigned next_class_id;
-
                PacketDefBase(unsigned);
        public:
-               virtual ~PacketDefBase() { }
+               virtual ~PacketDefBase() = default;
+
                virtual unsigned get_class_id() const = 0;
                unsigned get_id() const { return id; }
-               virtual std::string describe() const = 0;
+               virtual std::uint64_t get_hash() const = 0;
+               virtual const char *deserialize(Variant &, const char *, const char *) const = 0;
                virtual const char *dispatch(ReceiverBase &, const char *, const char *) const = 0;
        };
 
@@ -180,26 +155,23 @@ private:
        class PacketTypeDef: public PacketDefBase
        {
        private:
-               CompoundTypeDef<P> *compound;
-
-               static unsigned class_id;
+               std::unique_ptr<Serializer<P>> serializer;
 
        public:
                PacketTypeDef(unsigned);
-               ~PacketTypeDef();
 
-               static unsigned get_static_class_id() { return class_id; }
-               virtual unsigned get_class_id() const { return class_id; }
+               unsigned get_class_id() const override { return get_packet_class_id<P>(); }
 
                template<typename S>
                void set_serializer(const S &);
 
-               const CompoundTypeDef<P> &get_compound() const { return *compound; }
+               const Serializer<P> &get_serializer() const { return *serializer; }
 
-               virtual std::string describe() const { return compound->describe(); }
+               std::uint64_t get_hash() const override { return serializer->get_hash(); }
                char *serialize(const P &, char *, char *) const;
                const char *deserialize(P &, const char *, const char *) const;
-               virtual const char *dispatch(ReceiverBase &, const char *, const char *) const;
+               const char *deserialize(Variant &, const char *, const char *) const override;
+               const char *dispatch(ReceiverBase &, const char *, const char *) const override;
        };
 
        template<typename P, typename S>
@@ -212,41 +184,36 @@ private:
 
        public:
                PacketDefBuilder(const Protocol &, PacketTypeDef<P> &, const S &);
-               
-               template<typename T>
-               PacketDefBuilder<P, typename S::template Next<T>::Type> operator()(T P::*);
-       };
 
-       struct PacketHeader
-       {
-               UInt16 type;
-               UInt16 length;
+               template<typename T>
+               PacketDefBuilder<P, typename S::template Next<T>> fields(T P::*);
 
-               PacketHeader();
-               PacketHeader(UInt16, UInt16);
+               template<typename T1, typename T2, typename... Rest>
+               auto fields(T1 P::*first, T2 P::*second, Rest P::*...rest) { return fields(first).fields(second, rest...); }
        };
 
-       typedef std::map<unsigned, PacketDefBase *> PacketMap;
-
        PacketTypeDef<PacketHeader> header_def;
-       unsigned next_packet_id;
-       PacketMap packet_class_defs;
-       PacketMap packet_id_defs;
+       unsigned next_packet_id = 1;
+       std::map<unsigned, std::unique_ptr<PacketDefBase>> packet_class_defs;
+       std::map<unsigned, PacketDefBase *> packet_id_defs;
 
 protected:
-       Protocol(unsigned = 1);
-public:
-       ~Protocol();
+       Protocol();
 
 private:
-       void add_packet(PacketDefBase *);
+       static unsigned get_next_packet_class_id();
 
-protected:
        template<typename P>
-       PacketDefBuilder<P, NullSerializer<P> > add(unsigned);
+       static unsigned get_packet_class_id();
 
+       void add_packet(std::unique_ptr<PacketDefBase>);
+
+protected:
        template<typename P>
-       PacketDefBuilder<P, NullSerializer<P> > add();
+       PacketDefBuilder<P, Serializer<P>> add();
+
+       template<typename P, typename T, typename... Rest>
+       auto add(T P::*field, Rest P::*...rest) { return add<P>().fields(field, rest...); }
 
        const PacketDefBase &get_packet_by_class_id(unsigned) const;
        const PacketDefBase &get_packet_by_id(unsigned) const;
@@ -256,123 +223,103 @@ protected:
 
 public:
        template<typename P>
-       unsigned serialize(const P &, char *, unsigned) const;
+       bool has_packet() const { return packet_class_defs.count(get_packet_class_id<P>()); }
 
-       unsigned get_packet_size(const char *, unsigned) const;
-       unsigned dispatch(ReceiverBase &, const char *, unsigned) const;
+       template<typename P>
+       unsigned get_packet_id() const { return get_item(packet_class_defs, get_packet_class_id<P>())->get_id(); }
 
-       UInt64 get_hash() const;
+       unsigned get_max_packet_id() const;
 
-private:
-       template<typename T>
-       static std::string get_type_signature();
+       template<typename P>
+       std::size_t serialize(const P &, char *, std::size_t, unsigned = 0) const;
+
+       bool get_packet_header(PacketHeader &, const char *, std::size_t) const;
+       std::size_t get_packet_size(const char *, std::size_t) const;
+       std::size_t dispatch(ReceiverBase &, const char *, std::size_t, unsigned = 0) const;
+
+       std::uint64_t get_hash() const;
 };
 
 
 template<typename P>
-Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add(unsigned id)
+unsigned Protocol::get_packet_class_id()
 {
-       PacketTypeDef<P> *pdef = new PacketTypeDef<P>(id);
-       add_packet(pdef);
-       return PacketDefBuilder<P, NullSerializer<P> >(*this, *pdef, NullSerializer<P>());
+       static unsigned id = get_next_packet_class_id();
+       return id;
 }
 
 template<typename P>
-Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add()
+Protocol::PacketDefBuilder<P, Protocol::Serializer<P>> Protocol::add()
 {
-       return add<P>(next_packet_id++);
+       std::unique_ptr<PacketTypeDef<P>> pdef = std::make_unique<PacketTypeDef<P>>(next_packet_id++);
+       PacketDefBuilder<P, Serializer<P>> next(*this, *pdef, Serializer<P>());
+       add_packet(move(pdef));
+       return next;
 }
 
 template<typename P>
 const Protocol::PacketTypeDef<P> &Protocol::get_packet_by_class() const
 {
-       const PacketDefBase &pdef = get_packet_by_class_id(PacketTypeDef<P>::get_static_class_id());
+       const PacketDefBase &pdef = get_packet_by_class_id(get_packet_class_id<P>());
        return static_cast<const PacketTypeDef<P> &>(pdef);
 }
 
 template<typename P>
-unsigned Protocol::serialize(const P &pkt, char *buf, unsigned size) const
+std::size_t Protocol::serialize(const P &pkt, char *buf, std::size_t size, unsigned base_id) const
 {
        const PacketTypeDef<P> &pdef = get_packet_by_class<P>();
+       if(!pdef.get_id())
+               throw std::invalid_argument("no packet id");
        char *ptr = pdef.serialize(pkt, buf+4, buf+size);
        size = ptr-buf;
-       header_def.serialize(PacketHeader(pdef.get_id(), size), buf, buf+4);
+       header_def.serialize(PacketHeader(base_id+pdef.get_id(), size), buf, buf+4);
        return size;
 }
 
-template<typename T>
-std::string Protocol::get_type_signature()
-{
-       const UInt16 sig = Traits<T>::signature;
-       std::string result;
-       result += sig&0xFF;
-       if(sig>=0x100)
-               result += '0'+(sig>>8);
-       return result;
-}
-
 
-template<typename T, UInt8 K>
+template<typename T, std::uint8_t K>
 struct Protocol::BasicTraits
 {
-       static const UInt16 signature = K | (sizeof(T)<<8);
+       static const std::uint16_t signature = K | (sizeof(T)<<8);
        typedef BasicSerializer<T> Serializer;
 };
 
 template<typename T>
 struct Protocol::Traits
 {
-       static const UInt16 signature = 'C';
+       static const std::uint16_t signature = 'C';
        typedef CompoundSerializer<T> Serializer;
 };
 
-template<> struct Protocol::Traits<Int8>: BasicTraits<Int8, 'I'> { };
-template<> struct Protocol::Traits<UInt8>: BasicTraits<UInt8, 'U'> { };
-template<> struct Protocol::Traits<Int16>: BasicTraits<Int16, 'I'> { };
-template<> struct Protocol::Traits<UInt16>: BasicTraits<UInt16, 'U'> { };
-template<> struct Protocol::Traits<Int32>: BasicTraits<Int32, 'I'> { };
-template<> struct Protocol::Traits<UInt32>: BasicTraits<UInt32, 'U'> { };
-template<> struct Protocol::Traits<Int64>: BasicTraits<Int64, 'I'> { };
-template<> struct Protocol::Traits<UInt64>: BasicTraits<UInt64, 'U'> { };
+template<> struct Protocol::Traits<bool>: BasicTraits<bool, 'B'> { };
+template<> struct Protocol::Traits<std::int8_t>: BasicTraits<std::int8_t, 'I'> { };
+template<> struct Protocol::Traits<std::uint8_t>: BasicTraits<std::uint8_t, 'U'> { };
+template<> struct Protocol::Traits<std::int16_t>: BasicTraits<std::int16_t, 'I'> { };
+template<> struct Protocol::Traits<std::uint16_t>: BasicTraits<std::uint16_t, 'U'> { };
+template<> struct Protocol::Traits<std::int32_t>: BasicTraits<std::int32_t, 'I'> { };
+template<> struct Protocol::Traits<std::uint32_t>: BasicTraits<std::uint32_t, 'U'> { };
+template<> struct Protocol::Traits<std::int64_t>: BasicTraits<std::int64_t, 'I'> { };
+template<> struct Protocol::Traits<std::uint64_t>: BasicTraits<std::uint64_t, 'U'> { };
 template<> struct Protocol::Traits<float>: BasicTraits<float, 'F'> { };
 template<> struct Protocol::Traits<double>: BasicTraits<double, 'F'> { };
 
 template<> struct Protocol::Traits<std::string>
 {
-       static const UInt16 signature = 'S';
+       static const std::uint16_t signature = 'S';
        typedef StringSerializer Serializer;
 };
 
 template<typename T>
-struct Protocol::Traits<std::vector<T> >
+struct Protocol::Traits<std::vector<T>>
 {
-       static const UInt16 signature = 'A';
-       typedef ArraySerializer<std::vector<T> > Serializer;
+       static const std::uint16_t signature = 'A';
+       typedef ArraySerializer<std::vector<T>> Serializer;
 };
 
 
-
-template<typename C, typename S>
-Protocol::CompoundDef<C, S>::CompoundDef(const S &s):
-       serializer(s)
-{ }
-
-template<typename C, typename S>
-std::string Protocol::CompoundDef<C, S>::describe() const
+inline std::uint64_t Protocol::StringSerializer::get_hash() const
 {
-       return "{"+serializer.describe()+"}";
-}
-
-template<typename C, typename S>
-char *Protocol::CompoundDef<C, S>::serialize(const C &com, char *buf, char *end) const
-{
-       return serializer.serialize(com, buf, end);
-}
-
-template<typename C, typename S>
-const char *Protocol::CompoundDef<C, S>::deserialize(C &com, const char *buf, const char *end) const
-{
-       return serializer.deserialize(com, buf, end);
+       return Traits<std::string>::signature;
 }
 
 
@@ -383,24 +330,24 @@ Protocol::ArraySerializer<A>::ArraySerializer(const Protocol &proto):
 { }
 
 template<typename A>
-std::string Protocol::ArraySerializer<A>::describe() const
+std::uint64_t Protocol::ArraySerializer<A>::get_hash() const
 {
-       return "["+element_serializer.describe()+"]";
+       return hash_round<64>(element_serializer.get_hash(), 'A');
 }
 
 template<typename A>
 char *Protocol::ArraySerializer<A>::serialize(const A &array, char *buf, char *end) const
 {
        buf = length_serializer.serialize(array.size(), buf, end);
-       for(typename A::const_iterator i=array.begin(); i!=array.end(); ++i)
-               buf = element_serializer.serialize(*i, buf, end);
+       for(const auto &e: array)
+               buf = element_serializer.serialize(e, buf, end);
        return buf;
 }
 
 template<typename A>
 const char *Protocol::ArraySerializer<A>::deserialize(A &array, const char *buf, const char *end) const
 {
-       UInt16 length;
+       std::uint16_t length;
        buf = length_serializer.deserialize(length, buf, end);
        array.resize(length);
        for(unsigned i=0; i<length; ++i)
@@ -411,86 +358,88 @@ const char *Protocol::ArraySerializer<A>::deserialize(A &array, const char *buf,
 
 template<typename C>
 Protocol::CompoundSerializer<C>::CompoundSerializer(const Protocol &proto):
-       def(proto.get_packet_by_class<C>().get_compound())
+       serializer(proto.get_packet_by_class<C>().get_serializer())
 { }
 
+template<typename C>
+std::uint64_t Protocol::CompoundSerializer<C>::get_hash() const
+{
+       return hash_round<64>(serializer.get_hash(), 'C');
+}
+
 template<typename C>
 char *Protocol::CompoundSerializer<C>::serialize(const C &com, char *buf, char *end) const
 {
-       return def.serialize(com, buf, end);
+       return serializer.serialize(com, buf, end);
 }
 
 template<typename C>
 const char *Protocol::CompoundSerializer<C>::deserialize(C &com, const char *buf, const char *end) const
 {
-       return def.deserialize(com, buf, end);
+       return serializer.deserialize(com, buf, end);
 }
 
 
-template<typename P, typename Head, typename S>
-Protocol::Serializer<P, Head, S>::Serializer(const Head &h, Pointer p, const Protocol &proto):
+template<typename C, typename Head, typename T>
+Protocol::FieldSerializer<C, Head, T>::FieldSerializer(const Head &h, T C::*p, const Protocol &proto):
        Head(h),
        ptr(p),
        ser(proto)
 { }
 
-template<typename P, typename Head, typename S>
-std::string Protocol::Serializer<P, Head, S>::describe() const
+template<typename C, typename Head, typename T>
+std::uint64_t Protocol::FieldSerializer<C, Head, T>::get_hash() const
 {
-       return Head::describe()+ser.describe();
+       return hash_update<64>(Head::get_hash(), ser.get_hash());
 }
 
-template<typename P, typename Head, typename S>
-char *Protocol::Serializer<P, Head, S>::serialize(const P &pkt, char *buf, char *end) const
+template<typename C, typename Head, typename T>
+char *Protocol::FieldSerializer<C, Head, T>::serialize(const C &com, char *buf, char *end) const
 {
-       buf = Head::serialize(pkt, buf, end);
-       return ser.serialize(pkt.*ptr, buf, end);
+       buf = Head::serialize(com, buf, end);
+       return ser.serialize(com.*ptr, buf, end);
 }
 
-template<typename P, typename Head, typename S>
-const char *Protocol::Serializer<P, Head, S>::deserialize(P &pkt, const char *buf, const char *end) const
+template<typename C, typename Head, typename T>
+const char *Protocol::FieldSerializer<C, Head, T>::deserialize(C &com, const char *buf, const char *end) const
 {
-       buf = Head::deserialize(pkt, buf, end);
-       return ser.deserialize(pkt.*ptr, buf, end);
+       buf = Head::deserialize(com, buf, end);
+       return ser.deserialize(com.*ptr, buf, end);
 }
 
 
-template<typename P>
-unsigned Protocol::PacketTypeDef<P>::class_id = 0;
-
 template<typename P>
 Protocol::PacketTypeDef<P>::PacketTypeDef(unsigned i):
        PacketDefBase(i),
-       compound(new CompoundDef<P, NullSerializer<P> >(NullSerializer<P>()))
-{
-       if(!class_id)
-               class_id = next_class_id++;
-}
-
-template<typename P>
-Protocol::PacketTypeDef<P>::~PacketTypeDef()
-{
-       delete compound;
-}
+       serializer(std::make_unique<Serializer<P>>())
+{ }
 
 template<typename P>
 template<typename S>
 void Protocol::PacketTypeDef<P>::set_serializer(const S &ser)
 {
-       delete compound;
-       compound = new CompoundDef<P, S>(ser);
+       serializer = std::make_unique<S>(ser);
 }
 
 template<typename P>
 char *Protocol::PacketTypeDef<P>::serialize(const P &pkt, char *buf, char *end) const
 {
-       return compound->serialize(pkt, buf, end);
+       return serializer->serialize(pkt, buf, end);
 }
 
 template<typename P>
 const char *Protocol::PacketTypeDef<P>::deserialize(P &pkt, const char *buf, const char *end) const
 {
-       return compound->deserialize(pkt, buf, end);
+       return serializer->deserialize(pkt, buf, end);
+}
+
+template<typename P>
+const char *Protocol::PacketTypeDef<P>::deserialize(Variant &var_pkt, const char *buf, const char *end) const
+{
+       P pkt;
+       const char *ptr = serializer->deserialize(pkt, buf, end);
+       var_pkt = std::move(pkt);
+       return ptr;
 }
 
 template<typename P>
@@ -515,11 +464,11 @@ Protocol::PacketDefBuilder<P, S>::PacketDefBuilder(const Protocol &p, PacketType
 
 template<typename P, typename S>
 template<typename T>
-Protocol::PacketDefBuilder<P, typename S::template Next<T>::Type> Protocol::PacketDefBuilder<P, S>::operator()(T P::*ptr)
+Protocol::PacketDefBuilder<P, typename S::template Next<T>> Protocol::PacketDefBuilder<P, S>::fields(T P::*ptr)
 {
-       typename S::template Next<T>::Type next_ser(serializer, ptr, protocol);
+       typename S::template Next<T> next_ser(serializer, ptr, protocol);
        pktdef.set_serializer(next_ser);
-       return PacketDefBuilder<P, typename S::template Next<T>::Type>(protocol, pktdef, next_ser);
+       return PacketDefBuilder<P, typename S::template Next<T>>(protocol, pktdef, next_ser);
 }
 
 } // namespace Net