Support compound types in network packets

[libs/net.git] / source / net / protocol.h

diff --git a/source/net/protocol.h b/source/net/protocol.h
index f6c382c9f1ca003e2dbb982e0d7f59867c3a5ae3..0a8110c9518182f91ada3cfe48f0f09ecd579b98 100644 (file)
--- a/source/net/protocol.h
+++ b/source/net/protocol.h
@@ -40,6 +40,7 @@ private:
        {
                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;
        };
@@ -52,6 +53,7 @@ private:
                CompoundDef(const S &);
                virtual ~CompoundDef();
 
+               virtual std::string describe() const;
                virtual char *serialize(const C &, char *, char *) const;
                virtual const char *deserialize(C &, const char *, const char *) const;
        };
@@ -64,6 +66,7 @@ private:
 
                BasicSerializer(const Protocol &) { }
 
+               std::string describe() const { return get_type_signature<T>(); }
                char *serialize(const T &, char *, char *) const;
                const char *deserialize(T &, const char *, const char *) const;
        };
@@ -79,6 +82,7 @@ private:
        public:
                StringSerializer(const Protocol &);
 
+               std::string describe() const { return get_type_signature<std::string>(); }
                char *serialize(const std::string &, char *, char *) const;
                const char *deserialize(std::string &, const char *, const char *) const;
        };
@@ -96,10 +100,28 @@ private:
        public:
                ArraySerializer(const Protocol &);
 
+               std::string describe() const;
                char *serialize(const A &, char *, char *) const;
                const char *deserialize(A &, const char *, const char *) const;
        };
 
+       template<typename C>
+       class CompoundSerializer
+       {
+       public:
+               typedef C ValueType;
+
+       private:
+               const CompoundTypeDef<C> &def;
+
+       public:
+               CompoundSerializer(const Protocol &);
+
+               std::string describe() const { return def.describe(); }
+               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
        {
@@ -119,6 +141,7 @@ private:
        public:
                Serializer(const Head &, Pointer, const Protocol &);
 
+               std::string describe() const;
                char *serialize(const P &, char *, char *) const;
                const char *deserialize(P &, const char *, const char *) const;
        };
@@ -133,6 +156,7 @@ private:
                        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; }
        };
@@ -149,6 +173,7 @@ private:
                virtual ~PacketDefBase() { }
                virtual unsigned get_class_id() const = 0;
                unsigned get_id() const { return id; }
+               virtual std::string describe() const = 0;
                virtual const char *dispatch(ReceiverBase &, const char *, const char *) const = 0;
        };
 
@@ -172,6 +197,7 @@ private:
 
                const CompoundTypeDef<P> &get_compound() const { return *compound; }
 
+               virtual std::string describe() const;
                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;
@@ -217,6 +243,9 @@ private:
        void add_packet(PacketDefBase *);
 
 protected:
+       template<typename P>
+       PacketDefBuilder<P, NullSerializer<P> > add(unsigned);
+
        template<typename P>
        PacketDefBuilder<P, NullSerializer<P> > add();
 
@@ -233,18 +262,28 @@ public:
        unsigned get_packet_size(const char *, unsigned) const;
        unsigned dispatch(ReceiverBase &, const char *, unsigned) const;
 
-       unsigned get_hash() const;
+       UInt64 get_hash() const;
+
+private:
+       template<typename T>
+       static std::string get_type_signature();
 };
 
 
 template<typename P>
-Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add()
+Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add(unsigned id)
 {
-       PacketTypeDef<P> *pdef = new PacketTypeDef<P>(next_packet_id++);
+       PacketTypeDef<P> *pdef = new PacketTypeDef<P>(id);
        add_packet(pdef);
        return PacketDefBuilder<P, NullSerializer<P> >(*this, *pdef, NullSerializer<P>());
 }
 
+template<typename P>
+Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add()
+{
+       return add<P>(next_packet_id++);
+}
+
 template<typename P>
 const Protocol::PacketTypeDef<P> &Protocol::get_packet_by_class() const
 {
@@ -262,32 +301,53 @@ unsigned Protocol::serialize(const P &pkt, char *buf, unsigned size) const
        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>
 struct Protocol::BasicTraits
 {
+       static const UInt16 signature = K | (sizeof(T)<<8);
        typedef BasicSerializer<T> Serializer;
 };
 
-template<> struct Protocol::Traits<Int8>: BasicTraits<Int8> { };
-template<> struct Protocol::Traits<UInt8>: BasicTraits<UInt8> { };
-template<> struct Protocol::Traits<Int16>: BasicTraits<Int16> { };
-template<> struct Protocol::Traits<UInt16>: BasicTraits<UInt16> { };
-template<> struct Protocol::Traits<Int32>: BasicTraits<Int32> { };
-template<> struct Protocol::Traits<UInt32>: BasicTraits<UInt32> { };
-template<> struct Protocol::Traits<Int64>: BasicTraits<Int64> { };
-template<> struct Protocol::Traits<UInt64>: BasicTraits<UInt64> { };
-template<> struct Protocol::Traits<float>: BasicTraits<float> { };
-template<> struct Protocol::Traits<double>: BasicTraits<double> { };
+template<typename T>
+struct Protocol::Traits
+{
+       static const UInt16 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<float>: BasicTraits<float, 'F'> { };
+template<> struct Protocol::Traits<double>: BasicTraits<double, 'F'> { };
 
 template<> struct Protocol::Traits<std::string>
 {
+       static const UInt16 signature = 'S';
        typedef StringSerializer Serializer;
 };
 
 template<typename T>
 struct Protocol::Traits<std::vector<T> >
 {
+       static const UInt16 signature = 'A';
        typedef ArraySerializer<std::vector<T> > Serializer;
 };
 
@@ -304,6 +364,12 @@ Protocol::CompoundDef<C, S>::~CompoundDef()
        delete serializer;
 }
 
+template<typename C, typename S>
+std::string Protocol::CompoundDef<C, S>::describe() const
+{
+       return "{"+serializer->describe()+"}";
+}
+
 template<typename C, typename S>
 char *Protocol::CompoundDef<C, S>::serialize(const C &com, char *buf, char *end) const
 {
@@ -323,6 +389,12 @@ Protocol::ArraySerializer<A>::ArraySerializer(const Protocol &proto):
        element_serializer(proto)
 { }
 
+template<typename A>
+std::string Protocol::ArraySerializer<A>::describe() const
+{
+       return "["+element_serializer.describe()+"]";
+}
+
 template<typename A>
 char *Protocol::ArraySerializer<A>::serialize(const A &array, char *buf, char *end) const
 {
@@ -344,6 +416,24 @@ 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())
+{ }
+
+template<typename C>
+char *Protocol::CompoundSerializer<C>::serialize(const C &com, char *buf, char *end) const
+{
+       return def.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);
+}
+
+
 template<typename P, typename Head, typename S>
 Protocol::Serializer<P, Head, S>::Serializer(const Head &h, Pointer p, const Protocol &proto):
        Head(h),
@@ -351,6 +441,12 @@ Protocol::Serializer<P, Head, S>::Serializer(const Head &h, Pointer p, const Pro
        ser(proto)
 { }
 
+template<typename P, typename Head, typename S>
+std::string Protocol::Serializer<P, Head, S>::describe() const
+{
+       return Head::describe()+ser.describe();
+}
+
 template<typename P, typename Head, typename S>
 char * Protocol::Serializer<P, Head, S>::serialize(const P &pkt, char *buf, char *end) const
 {
@@ -392,6 +488,12 @@ void Protocol::PacketTypeDef<P>::set_serializer(const S &ser)
        compound = new CompoundDef<P, S>(ser);
 }
 
+template<typename P>
+std::string Protocol::PacketTypeDef<P>::describe() const
+{
+       return compound->describe();
+}
+
 template<typename P>
 char *Protocol::PacketTypeDef<P>::serialize(const P &pkt, char *buf, char *end) const
 {