C++ client library for the WAMP protocol.
C++ QMake Other

README.md

CppWAMP

C++11 client library for the WAMP protocol.

Features:

  • Supports the WAMP Basic Profile
  • Supports some advanced WAMP profile features
  • Roles: Caller, Callee, Subscriber, Publisher
  • Transports: TCP and Unix domain raw sockets (with and without handshaking support)
  • Serializations: JSON and MsgPack
  • Provides both callback and co-routine based asynchronous APIs
  • Easy conversion between static and dynamic types
  • RPC and pub/sub event handlers can have static argument types
  • User-defined types can be registered and exchanged via RPC and pub-sub
  • Header-only, but may also be optionally compiled
  • Unit tested
  • Permissive license (Boost)

Dependencies:

Project Status

THIS LIBRARY IS STILL IN A PRELIMINARY STATE, AND ITS API IS SUBJECT TO CHANGE WITHOUT WARNING.

Installation

Documentation

Tested Platforms

This library has been tested with:

  • GCC 4.8.2, x86_64-linux-gnu, on Linux Mint 17 (based on Ubuntu 14.04)
  • Clang 3.6.0, x86_64-pc-linux-gnu, on Linux Mint 17
  • GCC 4.9.2 on Debian 8.0 "jessie"
  • Xcode 6.3.1 (Clang 602.0.49) on OS X 10.10.3

Usage Examples (using coroutines)

For a more comprehensive overview, check out the Tutorials in the wiki.

Establishing a WAMP session

wamp::AsioService iosvc;
boost::asio::spawn(iosvc, [&](boost::asio::yield_context yield)
{
    // Specify a TCP transport and JSON serialization
    auto tcp = connector<Json>(iosvc, TcpHost("localhost", 8001));
    auto session = wamp::CoroSession<>::create(iosvc, tcp);
    session->connect(yield);
    auto sessionInfo = session->join(Realm("myrealm"), yield);
    std::cout << "Client joined. Session ID = "
              << sessionInfo.id() << "\n";
    // etc.
});
iosvc.run();

Registering a remote procedure

boost::asio::spawn(iosvc, [&](boost::asio::yield_context yield)
{
    :::
    session->enroll(Procedure("add"), basicRpc<int, int, int>(
                    [](int n, int m) -> int {return n+m;}),
                    yield);
    :::
});

Calling a remote procedure

auto result = session->call(Rpc("add").withArgs(2, 2), yield);
std::cout << "2 + 2 is " << result[0].to<int>() << "\n";

Subscribing to a topic

void sensorSampled(float value)
{
    std::cout << "Sensor sampled, value = " << value << "\n";
}

boost::asio::spawn(iosvc, [&](boost::asio::yield_context yield)
{
    :::
    session->subscribe(Topic("sensorSampled"),
                       basicEvent<float>(&sensorSampled),
                       yield);
    :::
});

Publishing an event

float value = std::rand() % 10;
session->publish(Pub("sensorSampled").withArgs(value));

Supported Advanced Profile Features

  • General: agent identification, feature announcement
  • Callee: call_trustlevels, caller_identification, pattern_based_registration, progressive_call_results
  • Caller: call_timeout, caller_identification
  • Publisher: publisher_exclusion, publisher_identification, subscriber_blackwhite_listing
  • Subscriber: pattern_based_subscription, publication_trustlevels, publisher_identification

Questions, Discussions, and Issues

For general questions and discussions regarding CppWAMP, please use the CppWAMP Google Group (membership required).

For reporting bugs or for suggesting enhancements, please use the GitHub issue tracker.

License

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Copyright © Butterfly Energy Systems, 2014-2015