Made further refinements to the API.

- The library now depends on Boost 1.58, which now includes Boost.Endian. This removes the dependency on the "standalone" Boost.Endian (closes #5).
- Revamped subscriptions and registrations to more closely model Boost.Signals2 connection management. Users are no longer forced to keep `Subscription`/`Registration` objects alive. `ScopedSubscription` and `ScopedRegistraton` have been added to permit automatic lifetime management, if desired (closes #45).
- RPC handlers are now required to return an `Outcome` object. This makes it harder to forget returning a result from within an RPC handler (closes #46).
- Statically-typed call/event handlers are now handled by `EventUnpacker` and `InvocationUnpacker` wrappers. This eliminates the need for `Session::subscribe` and `Session::enroll` overloads, and greatly simplifies subscription/registration management (closes #51).
- Unpacking of positional arguments for statically-typed call/event slots now uses a simpler technique inspired by `std::integer_sequence` (closes #52)
- Updated examples and tests to use raw socket handshaking, which is now supported on Crossbar (closes #54).

Author: ecorm

CHANGELOG.md

@@ -1,3 +1,15 @@
+v0.3.0
+======
+Made further refinements to the API. The minimal Boost library version required is now 1.58.0.
+
+### Details
+- The library now depends on Boost 1.58, which now includes Boost.Endian. This removes the dependency on the "standalone" Boost.Endian (closes #5).
+- Revamped subscriptions and registrations to more closely model Boost.Signals2 connection management. Users are no longer forced to keep `Subscription`/`Registration` objects alive. `ScopedSubscription` and `ScopedRegistraton` have been added to permit automatic lifetime management, if desired (closes #45).
+- RPC handlers are now required to return an `Outcome` object. This makes it harder to forget returning a result from within an RPC handler (closes #46).
+- Statically-typed call/event handlers are now handled by `EventUnpacker` and `InvocationUnpacker` wrappers. This eliminates the need for `Session::subscribe` and `Session::enroll` overloads, and greatly simplifies subscription/registration management (closes #51).
+- Unpacking of positional arguments for statically-typed call/event slots now uses a simpler technique inspired by `std::integer_sequence` (closes #52)
+- Updated examples and tests to use raw socket handshaking, which is now supported on Crossbar (closes #54).
+
 v0.2.0
 ======
 Overhauled API to make use of fluent API techniques. Some Advanced WAMP Profile features are now supported.

CMakeLists.txt

@@ -9,9 +9,8 @@ cmake_minimum_required (VERSION 2.8)
 project (cppwamp)
 
 # First attempt to find Boost library directories
-set(BOOST_MIN_VERSION 1.56.0)
-#set(BOOST_COMPONENTS coroutine context thread system)
-set(BOOST_COMPONENTS coroutine context system)
+set(BOOST_MIN_VERSION 1.58.0)
+set(BOOST_COMPONENTS coroutine context thread system)
 set(BOOST_ROOT ./ext/boost)
 find_package(Boost ${BOOST_MIN_VERSION} COMPONENTS ${BOOST_COMPONENTS})
 if(Boost_FOUND)
@@ -31,15 +30,19 @@ set(PATH_LIB_BOOST ${SUGGESTED_BOOST_LIBRARY_PATH} CACHE PATH
 
 # Add GUI variables that let the user specify the include path for other
 # third-party libraries.
-set(PATH_INCLUDE_ENDIAN ${PROJECT_SOURCE_DIR}/ext/endian/include CACHE PATH
-    "Boost.Endian include path")
 set(PATH_INCLUDE_RAPIDJSON ${PROJECT_SOURCE_DIR}/ext/rapidjson/include CACHE PATH
     "RapidJson include path")
 set(PATH_INCLUDE_MSGPACK ${PROJECT_SOURCE_DIR}/ext/msgpack-c/include CACHE PATH
     "Msgpack-c include path")
 set(PATH_INCLUDE_CATCH ${PROJECT_SOURCE_DIR}/ext/Catch/include CACHE PATH
     "Catch include path")
 
+# Add GUI variables that let the user specify that legacy connectors should be
+# used for tests and examples.
+option(CPPWAMP_USE_NON_HANDSHAKING_TRANSPORTS
+       "Use non-handshaking raw socket transports in tests and examples"
+       OFF)
+
 # Confirm that the user's choices for the Boost library paths are valid.
 unset(BOOST_ROOT)
 set(BOOST_INCLUDEDIR ${PATH_INCLUDE_BOOST})
@@ -59,7 +62,6 @@ endif()
 # Add the include paths to third-party libraries
 include_directories(
     ${PATH_INCLUDE_BOOST}
-    ${PATH_INCLUDE_ENDIAN}
     ${PATH_INCLUDE_RAPIDJSON}
     ${PATH_INCLUDE_MSGPACK}
 )
@@ -77,6 +79,12 @@ if(CMAKE_USE_PTHREADS_INIT)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread")
 endif()
 
+# Add the appropriate preprocessor macro define if the user specified
+# non-handshaking transports.
+if(CPPWAMP_USE_NON_HANDSHAKING_TRANSPORTS)
+    add_definitions(-DCPPWAMP_USE_LEGACY_CONNECTORS)
+endif()
+
 # Add targets for the cppwamp library itself, units tests, and examples.
 add_subdirectory(cppwamp)
 add_subdirectory(test)

README.md

@@ -20,7 +20,7 @@ C++11 client library for the [WAMP][wamp] protocol.
 **Dependencies**:
 
 - [Boost.Asio][boost-asio] for raw socket transport
-- [Boost.Endian][boost-endian] (requires [Boost][boost] 1.57.0 or greater)
+- [Boost.Endian][boost-endian] (requires [Boost][boost] 1.58.0 or greater)
 - [RapidJSON][rapidjson]
 - [msgpack-c][msgpack-c]
 - (optional) [Boost.Coroutine][boost-coroutine] and
@@ -68,6 +68,8 @@ This library has been tested with:
 Usage Examples (using coroutines)
 ---------------------------------
 
+_For a more comprehensive overview, check out the [Tutorials](https://github.com/ecorm/cppwamp/wiki/Tutorial) in the wiki._
+
 ### Establishing a WAMP session
 ```c++
 wamp::AsioService iosvc;
@@ -90,25 +92,20 @@ iosvc.run();
 
 ### Registering a remote procedure
 ```c++
-void add(wamp::Invocation inv, int n, int m)
-{
-    inv.yield({n + m});
-}
-
 boost::asio::spawn(iosvc, [&](boost::asio::yield_context yield)
 {
     :::
-    auto reg = session->enroll<int, int>(Procedure("add"), &add, yield);
+    session->enroll(Procedure("add"), unpackedRpc<int, int>(
+                    [](wamp::Invocation inv, int n, int m) {return {n+m};}),
+                    yield);
     :::
 });
 ```
 
 ### Calling a remote procedure
 ```c++
 auto result = session->call(Rpc("add").withArgs({2, 2}), yield);
-int sum = 0;
-result.convertTo(sum);
-std::cout << "2 + 2 is " << sum << "\n";
+std::cout << "2 + 2 is " << result[0].to<int>() << "\n";
 ```
 
 ### Subscribing to a topic
@@ -122,8 +119,9 @@ void sensorSampled(wamp::Event event, float value)
 boost::asio::spawn(iosvc, [&](boost::asio::yield_context yield)
 {
     :::
-    auto sub = session->subscribe<float>(Topic("sensorSampled"),
-                                         &sensorSampled, yield);
+    session->subscribe(Topic("sensorSampled"),
+                       unpackedEvent<float>(&sensorSampled),
+                       yield);
     :::
 });
 ```
@@ -146,7 +144,7 @@ session->publish(Pub("sensorSampled").withArgs({value}));
 Questions, Discussions, and Issues
 ----------------------------------
 
-For general questions and discussion regarding CppWAMP, please use the
+For general questions and discussions regarding CppWAMP, please use the
 [CppWAMP Google Group][googlegroup] (membership required).
 
 For reporting bugs or for suggesting enhancements, please use the GitHub

cppwamp.pro

@@ -23,12 +23,5 @@ OTHER_FILES += \
     Doxyfile.in \
     doc/concepts.dox \
     doc/cppwamp.dox \
-    doc/args.md \
-    doc/async.md \
-    doc/connectors.md \
-    doc/errors.md \
-    doc/pubsub.md \
-    doc/rpc.md \
-    doc/sessions.md \
-    doc/tutorial.md \
-    doc/variant.md
+    doc/registrations.dox \
+    doc/subscriptions.dox

cppwamp/CMakeLists.txt

@@ -29,6 +29,7 @@ set(HEADERS
     include/cppwamp/subscription.hpp
     include/cppwamp/tcpconnector.hpp
     include/cppwamp/udsconnector.hpp
+    include/cppwamp/unpacker.hpp
     include/cppwamp/variant.hpp
     include/cppwamp/varianttuple.hpp
     include/cppwamp/version.hpp
@@ -47,15 +48,15 @@ set(HEADERS
     include/cppwamp/internal/legacyasioendpoint.hpp
     include/cppwamp/internal/legacyasiotransport.hpp
     include/cppwamp/internal/messagetraits.hpp
+    include/cppwamp/internal/precompiled.hpp
     include/cppwamp/internal/rawsockhandshake.hpp
     include/cppwamp/internal/rawsockheader.hpp
-    include/cppwamp/internal/registrationimpl.hpp
     include/cppwamp/internal/subscriber.hpp
-    include/cppwamp/internal/subscriptionimpl.hpp
     include/cppwamp/internal/tcpacceptor.hpp
     include/cppwamp/internal/tcpopener.hpp
     include/cppwamp/internal/udsacceptor.hpp
     include/cppwamp/internal/udsopener.hpp
+    include/cppwamp/internal/unpacker.ipp
     include/cppwamp/internal/variantbuilder.hpp
     include/cppwamp/internal/varianttraits.hpp
     include/cppwamp/internal/varianttraitsfwd.hpp
@@ -93,6 +94,8 @@ set(INLINES
 set(DOCUMENTS
     ${PROJECT_SOURCE_DIR}/doc/concepts.dox
     ${PROJECT_SOURCE_DIR}/doc/cppwamp.dox
+    ${PROJECT_SOURCE_DIR}/doc/registrations.dox
+    ${PROJECT_SOURCE_DIR}/doc/subscriptions.dox
 )
 
 # Treat *.ipp files as header files

cppwamp/cppwamp.pro

@@ -34,6 +34,7 @@ HEADERS += \
     include/cppwamp/subscription.hpp \
     include/cppwamp/tcpconnector.hpp \
     include/cppwamp/udsconnector.hpp \
+    include/cppwamp/unpacker.hpp \
     include/cppwamp/variant.hpp \
     include/cppwamp/varianttuple.hpp \
     include/cppwamp/version.hpp \
@@ -55,13 +56,12 @@ HEADERS += \
     include/cppwamp/internal/precompiled.hpp \
     include/cppwamp/internal/rawsockhandshake.hpp \
     include/cppwamp/internal/rawsockheader.hpp \
-    include/cppwamp/internal/registrationimpl.hpp \
     include/cppwamp/internal/subscriber.hpp \
-    include/cppwamp/internal/subscriptionimpl.hpp \
     include/cppwamp/internal/tcpacceptor.hpp \
     include/cppwamp/internal/tcpopener.hpp \
     include/cppwamp/internal/udsacceptor.hpp \
     include/cppwamp/internal/udsopener.hpp \
+    include/cppwamp/internal/unpacker.ipp \
     include/cppwamp/internal/variantbuilder.hpp \
     include/cppwamp/internal/varianttraits.hpp \
     include/cppwamp/internal/varianttraitsfwd.hpp \
@@ -107,8 +107,8 @@ QMAKE_CXXFLAGS += -std=c++11
 #Enable support for threads
 QMAKE_CXXFLAGS += -pthread
 
-#Stop compiling at first error
-#QMAKE_CXXFLAGS += -Wfatal-errors
+#Stop compiling after N errors
+QMAKE_CXXFLAGS += -fmax-errors=3
 
 #Add debugging symbols if in debug configuration
 CONFIG(debug, debug|release) {
@@ -120,7 +120,6 @@ CONFIG(debug, debug|release) {
 INCLUDEPATH += \
     $$PWD/include \
     $$PWD/../ext/boost \
-    $$PWD/../ext/endian/include \
     $$PWD/../ext/msgpack-c/include \
     $$PWD/../ext/rapidjson/include
 

cppwamp/include/cppwamp/corosession.hpp

@@ -106,7 +106,7 @@ class CoroSession : public TBase
     using EventSlot = std::function<void (Event)>;
 
     /** Function type for handling remote procedure calls. */
-    using CallSlot = std::function<void (Invocation)>;
+    using CallSlot = std::function<Outcome (Invocation)>;
 
     /** Yield context type used by the boost::asio::spawn handler. */
     template <typename TSpawnHandler>
@@ -150,19 +150,13 @@ class CoroSession : public TBase
     /// @{
     /** Subscribes to WAMP pub/sub events having the given topic. */
     template <typename H>
-    Subscription::Ptr subscribe(Topic topic, EventSlot slot,
-            YieldContext<H> yield, std::error_code* ec = nullptr);
-
-    /** Subscribes to WAMP pub/sub events having the given topic. */
-    template <typename THead, typename... TTail,
-              typename TEventSlot, typename H>
-    Subscription::Ptr subscribe(Topic topic, TEventSlot&& slot,
+    Subscription subscribe(Topic topic, EventSlot slot,
             YieldContext<H> yield, std::error_code* ec = nullptr);
 
     /** Unsubscribes a subscription to a topic and waits for router
         acknowledgement if necessary. */
     template <typename H>
-    bool unsubscribe(Subscription::Ptr sub, YieldContext<H> yield,
+    bool unsubscribe(const Subscription& sub, YieldContext<H> yield,
                      std::error_code* ec = nullptr);
 
     /** Publishes an event and waits for an acknowledgement from the router. */
@@ -175,18 +169,12 @@ class CoroSession : public TBase
     /// @{
     /** Registers a WAMP remote procedure call. */
     template <typename H>
-    Registration::Ptr enroll(Procedure procedure, CallSlot slot,
-            YieldContext<H> yield, std::error_code* ec = nullptr);
-
-    /** Registers a WAMP remote procedure call. */
-    template <typename THead, typename... TTail,
-              typename TCallSlot, typename H>
-    Registration::Ptr enroll(Procedure procedure, TCallSlot&& slot,
+    Registration enroll(Procedure procedure, CallSlot slot,
             YieldContext<H> yield, std::error_code* ec = nullptr);
 
     /** Unregisters a remote procedure call. */
     template <typename H>
-    bool unregister(Registration::Ptr reg, YieldContext<H> yield,
+    bool unregister(const Registration& reg, YieldContext<H> yield,
                     std::error_code* ec = nullptr);
 
     /** Calls a remote procedure */

cppwamp/include/cppwamp/internal/callee.hpp

@@ -14,30 +14,28 @@
 #include "../asyncresult.hpp"
 #include "../dialoguedata.hpp"
 #include "../sessiondata.hpp"
-#include "../variant.hpp"
+#include "../wampdefs.hpp"
 
 namespace wamp
 {
 
+class Registration;
+
 namespace internal
 {
 
 //------------------------------------------------------------------------------
 class Callee
 {
 public:
-    using Ptr               = std::shared_ptr<Callee>;
-    using WeakPtr           = std::weak_ptr<Callee>;
-    using RegistrationId    = uint64_t;
-    using RequestId         = uint64_t;
-    using UnregisterHandler = AsyncHandler<bool>;
+    using WeakPtr = std::weak_ptr<Callee>;
 
     virtual ~Callee() {}
 
-    virtual void unregister(RegistrationId regId) = 0;
+    virtual void unregister(const Registration& handle) = 0;
 
-    virtual void unregister(RegistrationId regId,
-                            UnregisterHandler handler) = 0;
+    virtual void unregister(const Registration& handle,
+                            AsyncHandler<bool> handler) = 0;
 
     virtual void yield(RequestId reqId, wamp::Result&& result) = 0;