Protocols.h

Go to the documentation of this file.

/*
 * Copyright 2006-2009 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_WSPR_PROTOCOL_PROTOCOLS_H
#define __SSRC_WSPR_PROTOCOL_PROTOCOLS_H

#include <ssrc/wispers-packages.h>
#include <ssrc/wisp/protocol.h>

__BEGIN_NS_SSRC_WSPR

using NS_SSRC_WISP::ByteBuffer;
using NS_SSRC_WISP::Packer;
using NS_SSRC_WISP::Unpacker;
using NS_SSRC_WISP::PackingTraits;
using NS_SSRC_WISP::BinaryPackingTraits;

__END_NS_SSRC_WSPR

__BEGIN_NS_SSRC_WSPR_PROTOCOL

enum MessageProtocol {
  // Wispers Standard Services (Reserved 0-1023)
  Unspecified = 0,
  Service     = 1,
  Registry    = 2,
  Log         = 3,
  Session     = 4,
  Renderer    = 5,
  Relay       = 6,
  WebService  = 7,
  GroupSession = 8,
  Login       = 9,
  Talk        = 10,
  Documents   = 11,
  Preferences = 12,
  Forum       = 13,
  Issues      = 14,
  Wiki        = 15,
  Blog        = 16,
  Notify      = 17,
  SiteSearch  = 18,
  Subscribe   = 19,
  TextShards  = 20,
  SimpleFS    = 21,
  MaxReserved = 1023
};

template<NS_SSRC_WISP_PROTOCOL::wisp_message_protocol protocol_>
std::string service_type();

template<NS_SSRC_WISP_PROTOCOL::wisp_message_protocol protocol_,
         typename PT = BinaryPackingTraits>
struct ServiceProtocol :
  public NS_SSRC_WISP_PROTOCOL::ServiceProtocol<protocol_, PT>
{
  static std::string service_type() {
    return NS_SSRC_WSPR_PROTOCOL::service_type<protocol_>();
  }

  static std::string service_group() {
    return service_type();
  }
};

#define WSPR_SERVICE_TYPE(service_base) "wspr.srv." #service_base
#define WSPR_EVENT_GROUP(service_base, event) \
  "wspr.evt." service_base "." event

#define WSPR_DEFINE_PROTOCOL(protocol_base, service_base) \
  template<> inline std::string service_type<protocol_base>() { \
    return WSPR_SERVICE_TYPE(service_base); \
  } \
  inline std::string service_type_ ## service_base () {  \
    return WSPR_SERVICE_TYPE(service_base); \
  } \
  template<NS_SSRC_WISP_PROTOCOL::wisp_message_id _id> \
  struct Message ## protocol_base : public NS_SSRC_WISP_UTILITY::wisp_struct { \
    static_assert(NS_SSRC_WSPR_PROTOCOL::protocol_base >= 0 &&         \
                  NS_SSRC_WSPR_PROTOCOL::protocol_base <= NS_SSRC_WSPR_PROTOCOL::MaxReserved, \
                  "protocol number out of range");                    \
    enum { protocol = NS_SSRC_WSPR_PROTOCOL::protocol_base };         \
    enum { id = _id }; \
    template<class Archive> \
    void serialize(Archive & ar, const unsigned int) { } \
  }

#define WSPR_SERVICE_CUSTOM_TYPE(service_base) "wspr.cust." #service_base

#define WSPR_DEFINE_CUSTOM_PROTOCOL(protocol_base, service_base) \
  inline std::string service_type_ ## service_base () {  \
    return WSPR_SERVICE_CUSTOM_TYPE(service_base); \
  } \
  template<NS_SSRC_WISP_PROTOCOL::wisp_message_id _id>    \
  struct Message ## protocol_base : public NS_SSRC_WISP_UTILITY::wisp_struct { \
    static_assert(static_cast<int>(protocol_base) > NS_SSRC_WSPR_PROTOCOL::MaxReserved, "protocol number out of range"); \
    enum { protocol = protocol_base }; \
    enum { id = _id }; \
    template<class Archive> \
    void serialize(Archive & ar, const unsigned int) { } \
  }

inline std::string service_type_unknown() {
  return WSPR_SERVICE_TYPE(unknown);
}

__END_NS_SSRC_WSPR_PROTOCOL

#endif