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 &);
54 virtual ~CompoundDef();
56 virtual std::string describe() const;
57 virtual char *serialize(const C &, char *, char *) const;
58 virtual const char *deserialize(C &, const char *, const char *) const;
67 BasicSerializer(const Protocol &) { }
69 std::string describe() const { return get_type_signature<T>(); }
70 char *serialize(const T &, char *, char *) const;
71 const char *deserialize(T &, const char *, const char *) const;
74 class StringSerializer
77 typedef std::string ValueType;
80 BasicSerializer<UInt16> length_serializer;
83 StringSerializer(const Protocol &);
85 std::string describe() const { return get_type_signature<std::string>(); }
86 char *serialize(const std::string &, char *, char *) const;
87 const char *deserialize(std::string &, const char *, const char *) const;
97 BasicSerializer<UInt16> length_serializer;
98 typename Traits<typename A::value_type>::Serializer element_serializer;
101 ArraySerializer(const Protocol &);
103 std::string describe() const;
104 char *serialize(const A &, char *, char *) const;
105 const char *deserialize(A &, const char *, const char *) const;
109 class CompoundSerializer
115 const CompoundTypeDef<C> &def;
118 CompoundSerializer(const Protocol &);
120 std::string describe() const { return def.describe(); }
121 char *serialize(const C &, char *, char *) const;
122 const char *deserialize(C &, const char *, const char *) const;
125 template<typename P, typename Head, typename S>
126 class Serializer: public Head
132 typedef Serializer<P, Serializer<P, Head, S>, typename Traits<N>::Serializer> Type;
136 typedef typename S::ValueType P::*Pointer;
142 Serializer(const Head &, Pointer, const Protocol &);
144 std::string describe() const;
145 char *serialize(const P &, char *, char *) const;
146 const char *deserialize(P &, const char *, const char *) const;
156 typedef Serializer<P, NullSerializer, typename Traits<N>::Serializer> Type;
159 std::string describe() const { return std::string(); }
160 char *serialize(const P &, char *b, char *) const { return b; }
161 const char *deserialize(P &, const char *b, const char *) const { return b; }
169 static unsigned next_class_id;
171 PacketDefBase(unsigned);
173 virtual ~PacketDefBase() { }
174 virtual unsigned get_class_id() const = 0;
175 unsigned get_id() const { return id; }
176 virtual std::string describe() const = 0;
177 virtual const char *dispatch(ReceiverBase &, const char *, const char *) const = 0;
181 class PacketTypeDef: public PacketDefBase
184 CompoundTypeDef<P> *compound;
186 static unsigned class_id;
189 PacketTypeDef(unsigned);
192 static unsigned get_static_class_id() { return class_id; }
193 virtual unsigned get_class_id() const { return class_id; }
196 void set_serializer(const S &);
198 const CompoundTypeDef<P> &get_compound() const { return *compound; }
200 virtual std::string describe() const;
201 char *serialize(const P &, char *, char *) const;
202 const char *deserialize(P &, const char *, const char *) const;
203 virtual const char *dispatch(ReceiverBase &, const char *, const char *) const;
206 template<typename P, typename S>
207 class PacketDefBuilder
210 const Protocol &protocol;
211 PacketTypeDef<P> &pktdef;
215 PacketDefBuilder(const Protocol &, PacketTypeDef<P> &, const S &);
218 PacketDefBuilder<P, typename S::template Next<T>::Type> operator()(T P::*);
227 PacketHeader(UInt16, UInt16);
230 typedef std::map<unsigned, PacketDefBase *> PacketMap;
232 PacketTypeDef<PacketHeader> header_def;
233 unsigned next_packet_id;
234 PacketMap packet_class_defs;
235 PacketMap packet_id_defs;
238 Protocol(unsigned = 1);
243 void add_packet(PacketDefBase *);
247 PacketDefBuilder<P, NullSerializer<P> > add(unsigned);
250 PacketDefBuilder<P, NullSerializer<P> > add();
252 const PacketDefBase &get_packet_by_class_id(unsigned) const;
253 const PacketDefBase &get_packet_by_id(unsigned) const;
256 const PacketTypeDef<P> &get_packet_by_class() const;
260 unsigned serialize(const P &, char *, unsigned) const;
262 unsigned get_packet_size(const char *, unsigned) const;
263 unsigned dispatch(ReceiverBase &, const char *, unsigned) const;
265 UInt64 get_hash() const;
269 static std::string get_type_signature();
274 Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add(unsigned id)
276 PacketTypeDef<P> *pdef = new PacketTypeDef<P>(id);
278 return PacketDefBuilder<P, NullSerializer<P> >(*this, *pdef, NullSerializer<P>());
282 Protocol::PacketDefBuilder<P, Protocol::NullSerializer<P> > Protocol::add()
284 return add<P>(next_packet_id++);
288 const Protocol::PacketTypeDef<P> &Protocol::get_packet_by_class() const
290 const PacketDefBase &pdef = get_packet_by_class_id(PacketTypeDef<P>::get_static_class_id());
291 return static_cast<const PacketTypeDef<P> &>(pdef);
295 unsigned Protocol::serialize(const P &pkt, char *buf, unsigned size) const
297 const PacketTypeDef<P> &pdef = get_packet_by_class<P>();
298 char *ptr = pdef.serialize(pkt, buf+4, buf+size);
300 header_def.serialize(PacketHeader(pdef.get_id(), size), buf, buf+4);
305 std::string Protocol::get_type_signature()
307 const UInt16 sig = Traits<T>::signature;
311 result += '0'+(sig>>8);
316 template<typename T, UInt8 K>
317 struct Protocol::BasicTraits
319 static const UInt16 signature = K | (sizeof(T)<<8);
320 typedef BasicSerializer<T> Serializer;
324 struct Protocol::Traits
326 static const UInt16 signature = 'C';
327 typedef CompoundSerializer<T> Serializer;
330 template<> struct Protocol::Traits<Int8>: BasicTraits<Int8, 'I'> { };
331 template<> struct Protocol::Traits<UInt8>: BasicTraits<UInt8, 'U'> { };
332 template<> struct Protocol::Traits<Int16>: BasicTraits<Int16, 'I'> { };
333 template<> struct Protocol::Traits<UInt16>: BasicTraits<UInt16, 'U'> { };
334 template<> struct Protocol::Traits<Int32>: BasicTraits<Int32, 'I'> { };
335 template<> struct Protocol::Traits<UInt32>: BasicTraits<UInt32, 'U'> { };
336 template<> struct Protocol::Traits<Int64>: BasicTraits<Int64, 'I'> { };
337 template<> struct Protocol::Traits<UInt64>: BasicTraits<UInt64, 'U'> { };
338 template<> struct Protocol::Traits<float>: BasicTraits<float, 'F'> { };
339 template<> struct Protocol::Traits<double>: BasicTraits<double, 'F'> { };
341 template<> struct Protocol::Traits<std::string>
343 static const UInt16 signature = 'S';
344 typedef StringSerializer Serializer;
348 struct Protocol::Traits<std::vector<T> >
350 static const UInt16 signature = 'A';
351 typedef ArraySerializer<std::vector<T> > Serializer;
356 template<typename C, typename S>
357 Protocol::CompoundDef<C, S>::CompoundDef(const S &s):
361 template<typename C, typename S>
362 Protocol::CompoundDef<C, S>::~CompoundDef()
367 template<typename C, typename S>
368 std::string Protocol::CompoundDef<C, S>::describe() const
370 return "{"+serializer->describe()+"}";
373 template<typename C, typename S>
374 char *Protocol::CompoundDef<C, S>::serialize(const C &com, char *buf, char *end) const
376 return serializer->serialize(com, buf, end);
379 template<typename C, typename S>
380 const char *Protocol::CompoundDef<C, S>::deserialize(C &com, const char *buf, const char *end) const
382 return serializer->deserialize(com, buf, end);
387 Protocol::ArraySerializer<A>::ArraySerializer(const Protocol &proto):
388 length_serializer(proto),
389 element_serializer(proto)
393 std::string Protocol::ArraySerializer<A>::describe() const
395 return "["+element_serializer.describe()+"]";
399 char *Protocol::ArraySerializer<A>::serialize(const A &array, char *buf, char *end) const
401 buf = length_serializer.serialize(array.size(), buf, end);
402 for(typename A::const_iterator i=array.begin(); i!=array.end(); ++i)
403 buf = element_serializer.serialize(*i, buf, end);
408 const char *Protocol::ArraySerializer<A>::deserialize(A &array, const char *buf, const char *end) const
411 buf = length_serializer.deserialize(length, buf, end);
412 array.resize(length);
413 for(unsigned i=0; i<length; ++i)
414 buf = element_serializer.deserialize(array[i], buf, end);
420 Protocol::CompoundSerializer<C>::CompoundSerializer(const Protocol &proto):
421 def(proto.get_packet_by_class<C>().get_compound())
425 char *Protocol::CompoundSerializer<C>::serialize(const C &com, char *buf, char *end) const
427 return def.serialize(com, buf, end);
431 const char *Protocol::CompoundSerializer<C>::deserialize(C &com, const char *buf, const char *end) const
433 return def.deserialize(com, buf, end);
437 template<typename P, typename Head, typename S>
438 Protocol::Serializer<P, Head, S>::Serializer(const Head &h, Pointer p, const Protocol &proto):
444 template<typename P, typename Head, typename S>
445 std::string Protocol::Serializer<P, Head, S>::describe() const
447 return Head::describe()+ser.describe();
450 template<typename P, typename Head, typename S>
451 char * Protocol::Serializer<P, Head, S>::serialize(const P &pkt, char *buf, char *end) const
453 buf = Head::serialize(pkt, buf, end);
454 return ser.serialize(pkt.*ptr, buf, end);
457 template<typename P, typename Head, typename S>
458 const char * Protocol::Serializer<P, Head, S>::deserialize(P &pkt, const char *buf, const char *end) const
460 buf = Head::deserialize(pkt, buf, end);
461 return ser.deserialize(pkt.*ptr, buf, end);
466 unsigned Protocol::PacketTypeDef<P>::class_id = 0;
469 Protocol::PacketTypeDef<P>::PacketTypeDef(unsigned i):
471 compound(new CompoundDef<P, NullSerializer<P> >(NullSerializer<P>()))
474 class_id = next_class_id++;
478 Protocol::PacketTypeDef<P>::~PacketTypeDef()
485 void Protocol::PacketTypeDef<P>::set_serializer(const S &ser)
488 compound = new CompoundDef<P, S>(ser);
492 std::string Protocol::PacketTypeDef<P>::describe() const
494 return compound->describe();
498 char *Protocol::PacketTypeDef<P>::serialize(const P &pkt, char *buf, char *end) const
500 return compound->serialize(pkt, buf, end);
504 const char *Protocol::PacketTypeDef<P>::deserialize(P &pkt, const char *buf, const char *end) const
506 return compound->deserialize(pkt, buf, end);
510 const char *Protocol::PacketTypeDef<P>::dispatch(ReceiverBase &rcv, const char *buf, const char *end) const
512 PacketReceiver<P> *prcv = dynamic_cast<PacketReceiver<P> *>(&rcv);
514 throw bad_packet("unsupported");
516 buf = deserialize(pkt, buf, end);
522 template<typename P, typename S>
523 Protocol::PacketDefBuilder<P, S>::PacketDefBuilder(const Protocol &p, PacketTypeDef<P> &k, const S &s):
529 template<typename P, typename S>
531 Protocol::PacketDefBuilder<P, typename S::template Next<T>::Type> Protocol::PacketDefBuilder<P, S>::operator()(T P::*ptr)
533 typename S::template Next<T>::Type next_ser(serializer, ptr, protocol);
534 pktdef.set_serializer(next_ser);
535 return PacketDefBuilder<P, typename S::template Next<T>::Type>(protocol, pktdef, next_ser);