1 #ifndef MSP_NET_PROTOCOL_H_
2 #define MSP_NET_PROTOCOL_H_
7 #include <msp/core/inttypes.h>
13 class bad_packet: public std::runtime_error
16 bad_packet(const std::string &w): std::runtime_error(w) { }
17 virtual ~bad_packet() throw() { }
21 class buffer_error: public std::runtime_error
24 buffer_error(const std::string &w): std::runtime_error(w) { }
25 virtual ~buffer_error() throw() { }
32 template<typename T, UInt8 K>
39 struct CompoundTypeDef
41 virtual ~CompoundTypeDef() { }
43 virtual std::string describe() const = 0;
44 virtual char *serialize(const C &, char *, char *) const = 0;
45 virtual const char *deserialize(C &, const char *, const char *) const = 0;
48 template<typename C, typename S>
49 struct CompoundDef: public CompoundTypeDef<C>
53 CompoundDef(const S &);
55 virtual std::string describe() const;
56 virtual char *serialize(const C &, char *, char *) const;
57 virtual const char *deserialize(C &, const char *, const char *) const;
66 BasicSerializer(const Protocol &) { }
68 std::string describe() const { return get_type_signature<T>(); }
69 char *serialize(const T &, char *, char *) const;
70 const char *deserialize(T &, const char *, const char *) const;
73 class StringSerializer
76 typedef std::string ValueType;
79 BasicSerializer<UInt16> length_serializer;
82 StringSerializer(const Protocol &);
84 std::string describe() const { return get_type_signature<std::string>(); }
85 char *serialize(const std::string &, char *, char *) const;
86 const char *deserialize(std::string &, const char *, const char *) const;
96 BasicSerializer<UInt16> length_serializer;
97 typename Traits<typename A::value_type>::Serializer element_serializer;
100 ArraySerializer(const Protocol &);
102 std::string describe() const;
103 char *serialize(const A &, char *, char *) const;
104 const char *deserialize(A &, const char *, const char *) const;
108 class CompoundSerializer
114 const CompoundTypeDef<C> &def;
117 CompoundSerializer(const Protocol &);
119 std::string describe() const { return def.describe(); }
120 char *serialize(const C &, char *, char *) const;
121 const char *deserialize(C &, const char *, const char *) const;
124 template<typename P, typename Head, typename S>
125 class Serializer: public Head
131 typedef Serializer<P, Serializer<P, Head, S>, typename Traits<N>::Serializer> Type;
135 typedef typename S::ValueType P::*Pointer;
141 Serializer(const Head &, Pointer, const Protocol &);
143 std::string describe() const;
144 char *serialize(const P &, char *, char *) const;
145 const char *deserialize(P &, const char *, const char *) const;
155 typedef Serializer<P, NullSerializer, typename Traits<N>::Serializer> Type;
158 std::string describe() const { return std::string(); }
159 char *serialize(const P &, char *b, char *) const { return b; }
160 const char *deserialize(P &, const char *b, const char *) const { return b; }
168 static unsigned next_class_id;
170 PacketDefBase(unsigned);
172 virtual ~PacketDefBase() { }
173 virtual unsigned get_class_id() const = 0;
174 unsigned get_id() const { return id; }
175 virtual std::string describe() const = 0;
176 virtual const char *dispatch(ReceiverBase &, const char *, const char *) const = 0;
180 class PacketTypeDef: public PacketDefBase
183 CompoundTypeDef<P> *compound;
185 static unsigned class_id;
188 PacketTypeDef(unsigned);
191 static unsigned get_static_class_id() { return class_id; }
192 virtual unsigned get_class_id() const { return class_id; }
195 void set_serializer(const S &);
197 const CompoundTypeDef<P> &get_compound() const { return *compound; }
199 virtual std::string describe() const { return compound->describe(); }
200 char *serialize(const P &, char *, char *) const;
201 const char *deserialize(P &, const char *, const char *) const;
202 virtual const char *dispatch(ReceiverBase &, const char *, const char *) const;
205 template<typename P, typename S>
206 class PacketDefBuilder
209 const Protocol &protocol;
210 PacketTypeDef<P> &pktdef;
214 PacketDefBuilder(const Protocol &, PacketTypeDef<P> &, const S &);
217 PacketDefBuilder<P, typename S::template Next<T>::Type> operator()(T P::*);
226 PacketHeader(UInt16, UInt16);
229 typedef std::map<unsigned, PacketDefBase *> PacketMap;
231 PacketTypeDef<PacketHeader> header_def;
232 unsigned next_packet_id;
233 PacketMap packet_class_defs;
234 PacketMap packet_id_defs;
237 Protocol(unsigned = 1);
242 void add_packet(PacketDefBase *);
246 PacketDefBuilder<P, NullSerializer<P> > add(unsigned);
249 PacketDefBuilder<P, NullSerializer<P> > add();
251 const PacketDefBase &get_packet_by_class_id(unsigned) const;
252 const PacketDefBase &get_packet_by_id(unsigned) const;
255 const PacketTypeDef<P> &get_packet_by_class() const;
259 unsigned serialize(const P &, char *, unsigned) const;
261 unsigned get_packet_size(const char *, unsigned) const;
262 unsigned dispatch(ReceiverBase &, const char *, unsigned) const;
264 UInt64 get_hash() const;
268 static std::string get_type_signature();
273 Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add(unsigned id)
275 PacketTypeDef<P> *pdef = new PacketTypeDef<P>(id);
277 return PacketDefBuilder<P, NullSerializer<P> >(*this, *pdef, NullSerializer<P>());
281 Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add()
283 return add<P>(next_packet_id++);
287 const Protocol::PacketTypeDef<P> &Protocol::get_packet_by_class() const
289 const PacketDefBase &pdef = get_packet_by_class_id(PacketTypeDef<P>::get_static_class_id());
290 return static_cast<const PacketTypeDef<P> &>(pdef);
294 unsigned Protocol::serialize(const P &pkt, char *buf, unsigned size) const
296 const PacketTypeDef<P> &pdef = get_packet_by_class<P>();
297 char *ptr = pdef.serialize(pkt, buf+4, buf+size);
299 header_def.serialize(PacketHeader(pdef.get_id(), size), buf, buf+4);
304 std::string Protocol::get_type_signature()
306 const UInt16 sig = Traits<T>::signature;
310 result += '0'+(sig>>8);
315 template<typename T, UInt8 K>
316 struct Protocol::BasicTraits
318 static const UInt16 signature = K | (sizeof(T)<<8);
319 typedef BasicSerializer<T> Serializer;
323 struct Protocol::Traits
325 static const UInt16 signature = 'C';
326 typedef CompoundSerializer<T> Serializer;
329 template<> struct Protocol::Traits<Int8>: BasicTraits<Int8, 'I'> { };
330 template<> struct Protocol::Traits<UInt8>: BasicTraits<UInt8, 'U'> { };
331 template<> struct Protocol::Traits<Int16>: BasicTraits<Int16, 'I'> { };
332 template<> struct Protocol::Traits<UInt16>: BasicTraits<UInt16, 'U'> { };
333 template<> struct Protocol::Traits<Int32>: BasicTraits<Int32, 'I'> { };
334 template<> struct Protocol::Traits<UInt32>: BasicTraits<UInt32, 'U'> { };
335 template<> struct Protocol::Traits<Int64>: BasicTraits<Int64, 'I'> { };
336 template<> struct Protocol::Traits<UInt64>: BasicTraits<UInt64, 'U'> { };
337 template<> struct Protocol::Traits<float>: BasicTraits<float, 'F'> { };
338 template<> struct Protocol::Traits<double>: BasicTraits<double, 'F'> { };
340 template<> struct Protocol::Traits<std::string>
342 static const UInt16 signature = 'S';
343 typedef StringSerializer Serializer;
347 struct Protocol::Traits<std::vector<T> >
349 static const UInt16 signature = 'A';
350 typedef ArraySerializer<std::vector<T> > Serializer;
355 template<typename C, typename S>
356 Protocol::CompoundDef<C, S>::CompoundDef(const S &s):
360 template<typename C, typename S>
361 std::string Protocol::CompoundDef<C, S>::describe() const
363 return "{"+serializer.describe()+"}";
366 template<typename C, typename S>
367 char *Protocol::CompoundDef<C, S>::serialize(const C &com, char *buf, char *end) const
369 return serializer.serialize(com, buf, end);
372 template<typename C, typename S>
373 const char *Protocol::CompoundDef<C, S>::deserialize(C &com, const char *buf, const char *end) const
375 return serializer.deserialize(com, buf, end);
380 Protocol::ArraySerializer<A>::ArraySerializer(const Protocol &proto):
381 length_serializer(proto),
382 element_serializer(proto)
386 std::string Protocol::ArraySerializer<A>::describe() const
388 return "["+element_serializer.describe()+"]";
392 char *Protocol::ArraySerializer<A>::serialize(const A &array, char *buf, char *end) const
394 buf = length_serializer.serialize(array.size(), buf, end);
395 for(typename A::const_iterator i=array.begin(); i!=array.end(); ++i)
396 buf = element_serializer.serialize(*i, buf, end);
401 const char *Protocol::ArraySerializer<A>::deserialize(A &array, const char *buf, const char *end) const
404 buf = length_serializer.deserialize(length, buf, end);
405 array.resize(length);
406 for(unsigned i=0; i<length; ++i)
407 buf = element_serializer.deserialize(array[i], buf, end);
413 Protocol::CompoundSerializer<C>::CompoundSerializer(const Protocol &proto):
414 def(proto.get_packet_by_class<C>().get_compound())
418 char *Protocol::CompoundSerializer<C>::serialize(const C &com, char *buf, char *end) const
420 return def.serialize(com, buf, end);
424 const char *Protocol::CompoundSerializer<C>::deserialize(C &com, const char *buf, const char *end) const
426 return def.deserialize(com, buf, end);
430 template<typename P, typename Head, typename S>
431 Protocol::Serializer<P, Head, S>::Serializer(const Head &h, Pointer p, const Protocol &proto):
437 template<typename P, typename Head, typename S>
438 std::string Protocol::Serializer<P, Head, S>::describe() const
440 return Head::describe()+ser.describe();
443 template<typename P, typename Head, typename S>
444 char *Protocol::Serializer<P, Head, S>::serialize(const P &pkt, char *buf, char *end) const
446 buf = Head::serialize(pkt, buf, end);
447 return ser.serialize(pkt.*ptr, buf, end);
450 template<typename P, typename Head, typename S>
451 const char *Protocol::Serializer<P, Head, S>::deserialize(P &pkt, const char *buf, const char *end) const
453 buf = Head::deserialize(pkt, buf, end);
454 return ser.deserialize(pkt.*ptr, buf, end);
459 Protocol::PacketTypeDef<P>::PacketTypeDef(unsigned i):
461 compound(new CompoundDef<P, NullSerializer<P> >(NullSerializer<P>()))
464 class_id = next_class_id++;
468 Protocol::PacketTypeDef<P>::~PacketTypeDef()
475 void Protocol::PacketTypeDef<P>::set_serializer(const S &ser)
478 compound = new CompoundDef<P, S>(ser);
482 char *Protocol::PacketTypeDef<P>::serialize(const P &pkt, char *buf, char *end) const
484 return compound->serialize(pkt, buf, end);
488 const char *Protocol::PacketTypeDef<P>::deserialize(P &pkt, const char *buf, const char *end) const
490 return compound->deserialize(pkt, buf, end);
494 const char *Protocol::PacketTypeDef<P>::dispatch(ReceiverBase &rcv, const char *buf, const char *end) const
496 PacketReceiver<P> *prcv = dynamic_cast<PacketReceiver<P> *>(&rcv);
498 throw bad_packet("unsupported");
500 buf = deserialize(pkt, buf, end);
506 template<typename P, typename S>
507 Protocol::PacketDefBuilder<P, S>::PacketDefBuilder(const Protocol &p, PacketTypeDef<P> &k, const S &s):
513 template<typename P, typename S>
515 Protocol::PacketDefBuilder<P, typename S::template Next<T>::Type> Protocol::PacketDefBuilder<P, S>::operator()(T P::*ptr)
517 typename S::template Next<T>::Type next_ser(serializer, ptr, protocol);
518 pktdef.set_serializer(next_ser);
519 return PacketDefBuilder<P, typename S::template Next<T>::Type>(protocol, pktdef, next_ser);