Branch	Linux (Ubuntu 12.04) and OS X (10.10 & 10.11)	Windows (VS 2013 & 2015)
master
development

C++ Micro Services

Introduction

The C++ Micro Services library provides a dynamic service registry and bundle system, largely based the OSGi Core Release 5 specifications. It enables developers to create a service oriented and dynamic software stack.

Proper usage of the C++ Micro Services library leads to

• Re-use of software components
• Loose coupling
• Separation of concerns
• Clean APIs based on service interfaces
• Extensible systems

and more.

Requirements

This is a pure C++ implementation of the OSGi service model and a native version of OSGi bundles. It does not have any third-party library dependencies.

Supported Platforms

The library makes use of some C++11 features and compiles on many different platforms.

Minimum required compiler versions:

• GCC 4.6
• Clang 3.1
• Clang from XCode 6.4
• Visual Studio 2013

Below is a list of tested compiler/OS combinations:

• GCC 4.6.3 (Ubuntu 12.04) via Travis CI
• GCC 6.1.1 (Fedora 24)
• Clang 3.8.0 (Fedora 24)
• Clang XCode 6.4 (OS X 10.10) via Travis CI
• Clang XCode 7.3 (OS X 10.11) via Travis CI
• Visual Studio 2013 via Appveyor
• Visual Studio 2015 via Appveyor

Legal

The C++ Micro Services project was initially developed at the German Cancer Research Center. Its source code is hosted on the GitHub account of the primary author, located at https://github.com/CppMicroServices/CppMicroServices. See the COPYRIGHT file in the top-level directory for detailed copyright information.

This project is licensed under the Apache License v2.0.

Code of Conduct

CppMicroServices.org welcomes developers with different backgrounds and a broad range of experience. A diverse and inclusive community will create more great ideas, provide more unique perspectives, and produce more outstanding code. Our aim is to make the CppMicroServices community welcoming to everyone.

To provide clarity of what is expected of our members, CppMicroServices has adopted the code of conduct defined by contributor-covenant.org. This document is used across many open source communities, and we believe it articulates our values well.

Please refer to the Code of Conduct for further details.

Quick Start

Essentially, the C++ Micro Services library provides you with a powerful dynamic service registry, on top of a managed lifecycle for so-called bundles that are contained in shared or static libraries. Each bundle within a library has an associated BundleContext object, through which the service registry is accessed.

To query the registry for a service object implementing one or more specific interfaces, the code would look like this:

#include "cppmicroservices/BundleContext.h"
#include "SomeInterface.h"

using namespace cppmicroservices;

void UseService(BundleContext context)
{
  auto serviceRef = context.GetServiceReference<SomeInterface>();
  if (serviceRef)
  {
    auto service = context.GetService(serviceRef);
    if (service) { /* do something */ }
  }
}

Registering a service object against a certain interface looks like this:

#include "cppmicroservices/BundleContext.h"
#include "SomeInterface.h"

using namespace cppmicroservices;

void RegisterSomeService(BundleContext context, const std::shared_ptr<SomeInterface>& service)
{
  context.RegisterService<SomeInterface>(service);
}

The OSGi service model additionally allows to annotate services with properties and using these properties during service look-ups. It also allows to track the life-cycle of service objects. Please see the Documentation for more examples and tutorials and the API reference. There is also a blog post about OSGi Lite for C++.

Git Branch Conventions

The Git repository contains two eternal branches, master and development. The master branch contains production quality code and its HEAD points to the latest released version. The development branch is the default branch and contains the current state of development. Pull requests by default target the development branch. See Contribution to C++ Micro Services for details about the contribution process.`

Build Instructions

Please visit the Build Instructions page online.