API

Requirements and Dependencies

C++ ≥ 14
Boost Libraries ≥ 1.67.0

Adapter

Defined in header <vrpc/adapter.hpp>
Provides a set of macros to non-intrusively register existing code

When adapting existing C++ code, you must tell VRPC:

all classes and functions you want to use
all custom C++ data-types you want to expose

It is recommended to add the adapter code directly to the file that implements the main function.

IMPORTANT

Always define adapter macros and functions within the VRPC namespace, i.e.

namespace vrpc {
  // Adapter code goes here
}

Adapter Macros

VRPC basically uses only five different macro types to adapt existing code:

1. Constructors

VRPC_CTOR(<className>, <args>)

Use this macro to register constructors with arguments. Repeat this macro for all overloads you need.

2. Member functions

VRPC_MEMBER_FUNCTION(<className>, <returnValue>, <functionName>[, <args>])

Use this macro to register class member functions. Repeat this macro for all overloads you need.

For constant member functions use:

VRPC_CONST_MEMBER_FUNCTION(<className>, <returnValue>, <functionName>[, <args>])

3. Static functions

VRPC_STATIC_FUNCTION(<className>, <returnValue>, <functionName>[, <args>])

Use this macro to register static functions. Repeat this macro for all overloads you need.

4. Callbacks

VRPC_CALLBACK(<args>)

Use this macro if an argument of a function you bind reflects a callback. The provided arguments must match the expected signature of the callback.

5. Custom Types

VRPC_DEFINE_TYPE(<type>, <member1>, <member2>, ...)

Use this macro to expose custom data types, such as structs.

IMPORTANT

Windows is different. On windows the syntax of the macros is slightly different (as the MSVC++ compiler is broken for variadic macros). All member function and static function macros need to start with an underscore and must end with _<N> where N is the number of arguments in the macro.

To e.g. bind this member function of class Foo:

std::string bar(int, float);

use:

_VRPC_MEMBER_FUNCTION_5(Foo, std::string, bar, int, float)

Adding function and parameter documentation

You may want to add function and parameter documentation to the bound functions in order to help other users to understand how your API works.

IMPORTANT

If you want to support default values for function arguments, adding such meta information is essential!

Use a _X suffix to the binding macro which then allows for the following input:

VRPC_MEMBER_FUNCTION_X(
  <className>,
  <returnValue>, "<return value description>",
  <functionName>, "<function description>"[,
  <arg1>, "<arg name>", <defaultValue> | required(), "<arg description>"[,
  ...]]
)

To e.g. bind this member function of class Foo:

bool hasUser(const std::string& username, bool onlyLocal = false);

use:

VRPC_MEMBER_FUNCTION_X(
  Foo,
  bool, "returns true if user was found, false otherwise",
  hasUser, "checks whether a given user exists",
  const std::string&, "username", required(), "the username to be checked",
  bool, "onlyLocal", false, "set true to only check local users"
)

NOTE

Whenever your are using the _X suffix you must fully document the return value, the function and each argument. There is no possibility to skip any documentation information.

Adapting custom data types

Say your existing code had a struct:

// a simple struct to model a person
struct Person {
  std::string name;
  std::string address;
  int age;
};

Then on the top of your adapter file (before all other macros) add:

namespace vrpc {
  VRPC_DEFINE_TYPE(Person, name, address, age);
  // other macros follow here...
}

Once you exposed your custom data-types you are ready to use them as arguments in the binding macros (see above). They automatically also work within all STL containers and even as arguments of callback functions!

This feature is brought in by the library JSON for Modern C++ which is embedded in VRPC and depending on your needs you may want instead to define the low-level to_json and from_json functions. In that case just see there for more details.

Agent

Defined in header <vrpc/agent.hpp>
Provides class: vrpc::VrpcAgent

The vrpc::VrpcAgent establishes a connection to an MQTT broker and makes all classes and function that are bound through an binding.cpp file (see above) remotely available.

Options Struct

struct Options {
  std::string domain = "vrpc";
  std::string agent;
  std::string token;
  std::string plugin;
  std::string username;
  std::string password;
  std::string persistence_directory;
  std::string trust_store;
  std::string key_store;
  std::string private_key;
  std::string private_key_password;
  std::string enabled_cipher_suites;
  std::string broker = "ssl://vrpc.io:8883";
  bool enable_server_cert_auth = false;
};

Simple struct holding configuration options needed for VrpcAgent construction.

Static functions

std::shared_ptr<vrpc::VrpcAgent> vrpc::VrpcAgent::from_commandline( int argc, char** argv );

Creates a VrpcAgent instance from commandline parameters. The corresponding arguments of the main function can simply be handed over.

Parameters

argc - Argument count

argv - Array of argument values

Return Value

Shared pointer to an VrpcAgent instance. Will be a null pointer in case of wrong commandline arguments or if the help function was triggered.

std::shared_ptr<vrpc::VrpcAgent> vrpc::VrpcAgent::create( const Options& options );

Creates a VrpcAgent instance from provided options.

Parameters

options - Option object providing configuration information

Return Value

Shared pointer to an VrpcAgent instance.

Member functions

void serve();

Tries to establish a connection to the configured MQTT broker (bound to vrpc.io in the community edition) and if successful starts an underlying event-loop.

If not successful, serve tries re-connecting to the broker.

NOTE

This function is blocking, but can be continued by the signalsSIGINT, SIGTERM or SIGSEV, which stops the event-loop.

Example

#include <vrpc/agent.hpp>

int main(int argc, char** argv) {
  auto agent = VrpcAgent::from_commandline(argc, argv);
  if (agent) agent->serve();
  return EXIT_SUCCESS;
}

Last updated 27 days ago