ServiceProtocol.h

Go to the documentation of this file.

/*
 * Copyright 2006-2008 Savarese Software Research Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.savarese.com/software/ApacheLicense-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __SSRC_WISP_PROTOCOL_SERVICE_PROTOCOL_H
#define __SSRC_WISP_PROTOCOL_SERVICE_PROTOCOL_H

#include <ssrc/wisp/serialization.h>
#include <ssrc/wisp/utility/wisp_struct.h>

#include <ssrc/spread/Message.h>

#include <string>
#include <cstdint>

__BEGIN_NS_SSRC_WISP_PROTOCOL

/* We use Spread message type as our protocol indicator and
 * encode the message type inside the message itself.  This way, we
 * don't have to worry about running out of id numbers.
 */
typedef NS_SSRC_SPREAD::Message::message_type wisp_message_protocol;
typedef std::uint16_t wisp_message_id;

template<typename PT> class Caller;

template<wisp_message_protocol protocol_, typename PT = BinaryPackingTraits>
struct ServiceProtocol {
  enum { protocol = protocol_ };

  typedef PT packing_traits;
  typedef Caller<packing_traits> caller_type;
};

#define WISP_DEFINE_PROTOCOL(protocol_base) \
  template<NS_SSRC_WISP_PROTOCOL::wisp_message_id _id> \
  struct Message ## protocol_base : public NS_SSRC_WISP_UTILITY::wisp_struct { \
    enum { protocol = protocol_base }; \
    enum { id = _id }; \
    template<class Archive> \
    void serialize(Archive & ar, const unsigned int) { } \
  }

// These are convenience macros for pulling protocol structures into
// a class scope, where 'using' is disallowed.
#define WISP_IMPORT(a,b) typedef a::b b
#define WISP_IMPORT_T(a,b) typedef typename a::b b

// Convenience macros for defining message types.

#define __WISP_PROTOCOL_MESSAGE(in_template, call, base, members)      \
  struct BOOST_PP_CAT(Message, call) : public base<call> {             \
    BOOST_PP_SEQ_FOR_EACH(__WISP_STRUCT_MEMBER, _, members)            \
    BOOST_PP_CAT(Message, call)() :                                    \
    BOOST_PP_SEQ_FOR_EACH_I(__WISP_STRUCT_DEFAULT_INIT_MEMBER, _, members) { } \
      explicit BOOST_PP_CAT(Message, call)(BOOST_PP_SEQ_FOR_EACH_I(__WISP_STRUCT_PARAM, in_template, members)) : \
    BOOST_PP_SEQ_FOR_EACH_I(__WISP_STRUCT_INIT_MEMBER, _, members) { } \
    __WISP_STRUCT_SERIALIZE_MEMBERS(members)                           \
    __WISP_STRUCT_VISIT(members)                                       \
  }

#define __WISP_PROTOCOL_MESSAGE_WITH_INIT(in_template, call, base, members, initializers) \
  struct BOOST_PP_CAT(Message, call) : public base<call> {             \
    BOOST_PP_SEQ_FOR_EACH(__WISP_STRUCT_MEMBER, _, members)            \
      explicit BOOST_PP_CAT(Message, call)(BOOST_PP_SEQ_FOR_EACH_I(__WISP_STRUCT_PARAM_INIT, BOOST_PP_ARRAY_PUSH_FRONT(BOOST_PP_ARRAY_PUSH_FRONT(initializers, BOOST_PP_SUB(BOOST_PP_SEQ_SIZE(members), BOOST_PP_ARRAY_SIZE(initializers))), in_template), members)) : \
    BOOST_PP_SEQ_FOR_EACH_I(__WISP_STRUCT_INIT_MEMBER, _, members) { } \
    __WISP_STRUCT_SERIALIZE_MEMBERS(members)                           \
    __WISP_STRUCT_VISIT(members)                                       \
  }

#define WISP_PROTOCOL_MESSAGE(call, base, members) \
  __WISP_PROTOCOL_MESSAGE(0, call, base, members)

#define WISP_PROTOCOL_MESSAGE_T(call, base, members) \
  __WISP_PROTOCOL_MESSAGE(1, call, base, members)

#define WISP_PROTOCOL_MESSAGE_WITH_INIT(call, base, members, initializers) \
  __WISP_PROTOCOL_MESSAGE_WITH_INIT(0, call, base, members, BOOST_PP_SEQ_TO_ARRAY(initializers))

#define WISP_PROTOCOL_MESSAGE_WITH_INIT_T(call, base, members, initializers) \
  __WISP_PROTOCOL_MESSAGE_WITH_INIT(1, call, base, members, BOOST_PP_SEQ_TO_ARRAY(initializers))

__END_NS_SSRC_WISP_PROTOCOL

#endif