binarycodec.hpp

Go to the documentation of this file.

#pragma once
/*
**  Copyright (C) 2013 Aldebaran Robotics
**  See COPYING for the license
*/

#ifndef _QI_TYPE_BINARYCODEC_HPP_
#define _QI_TYPE_BINARYCODEC_HPP_

#include <qi/atomic.hpp>

#include <qi/api.hpp>
#include <boost/function.hpp>
#include <qi/buffer.hpp>
#include <qi/anyvalue.hpp>
#include <qi/type/metaobject.hpp>

namespace qi {

  struct ObjectSerializationInfo
  {
    ObjectSerializationInfo()
      : transmitMetaObject(true),
        metaObjectCachedId(notCached)
    {}

    MetaObject   metaObject;
    bool         transmitMetaObject;
    qi::uint32_t metaObjectCachedId;
    qi::uint32_t serviceId;
    qi::uint32_t objectId;
    static const qi::uint32_t notCached = 0xFFFFFFFF;
  };

  class StreamContext;

  using DeserializeObjectCallback = boost::function<AnyObject(const ObjectSerializationInfo&)>;

  using SerializeObjectCallback = boost::function<ObjectSerializationInfo(const AnyObject&)>;

  template <typename T>
  AnyReference decodeBinary(qi::BufferReader *buf, T* value,
                            DeserializeObjectCallback onObject=DeserializeObjectCallback(),
                            StreamContext* streamContext = 0
                            );

  QI_API void encodeBinary(qi::Buffer *buf, const AutoAnyReference &gvp, SerializeObjectCallback onObject=SerializeObjectCallback(), StreamContext* ctx=0);


  QI_API AnyReference decodeBinary(qi::BufferReader *buf, AnyReference gvp, DeserializeObjectCallback onObject=DeserializeObjectCallback(), StreamContext* ctx = 0);

  template <typename T>
  AnyReference decodeBinary(qi::BufferReader *buf, T* value, DeserializeObjectCallback onObject, StreamContext* ctx) {
    return decodeBinary(buf, AnyReference::fromPtr(value), onObject, ctx);
  }
}

#endif  // _QITYPE_BINARYCODEC_HPP_