An OSGi-like C++ dynamic module system and service registry
C++ CMake Python HTML JavaScript CSS
Clone or download
saschazelzer Merge pull request #294 from CppMicroServices/290-code-formatting
Updated clang format file and auxiliary documents. Formatted sources.
Latest commit 2ba8e4c Aug 4, 2018
Permalink
Failed to load latest commit information.
cmake Run clang-format on all sources, closes #290. Aug 2, 2018
doc Run clang-format on all sources, closes #290. Aug 2, 2018
framework Run clang-format on all sources, closes #290. Aug 2, 2018
httpservice Run clang-format on all sources, closes #290. Aug 2, 2018
shellservice Run clang-format on all sources, closes #290. Aug 2, 2018
third_party Update minimum compiler versions, fixes #201. Jul 29, 2018
tools Run clang-format on all sources, closes #290. Aug 2, 2018
util Run clang-format on all sources, closes #290. Aug 2, 2018
webconsole Run clang-format on all sources, closes #290. Aug 2, 2018
.clang-format Clang format and manual style fixes. Aug 2, 2018
.gitignore 200 gtest integration (#225) Aug 8, 2017
.travis.yml Update minimum compiler versions, fixes #201. Jul 29, 2018
CHANGELOG.rst Bump dev version to 4.0.0. Feb 19, 2018
CMakeLists.txt Update minimum compiler versions, fixes #201. Jul 29, 2018
CODE_OF_CONDUCT.rst Rename code-of-conduct file to match GitHub expectations. Aug 29, 2017
CONTRIBUTING.rst Clang format and manual style fixes. Aug 2, 2018
COPYRIGHT Fixed project url Mar 1, 2016
CTestConfig.cmake Initial commit Feb 28, 2012
CppMicroServicesConfig.cmake.in Use CMake usage requirements, bump CMake version to 3.1. Jan 18, 2017
CppMicroServicesConfigVersion.cmake.in Initial sphinx documentation plus CMake bug fixes. Jan 18, 2017
LICENSE Added LICENSE file and explicit link in README.md. Jan 3, 2013
README.rst Update minimum compiler versions, fixes #201. Jul 29, 2018
VERSION Bump dev version to 4.0.0. Feb 19, 2018
appveyor.yml AppVeyor environments for Visual Studio 2015 and 2017 builds, #201. May 11, 2018
codecov.yml Recursively ignore third-party and unit test code for code coverage Sep 4, 2017
conf.py Rename code-of-conduct file to match GitHub expectations. Aug 29, 2017
fixcoveragefilepaths.py Codecov (#219) Jul 17, 2017
format_code.sh Clang format and manual style fixes. Aug 2, 2018
index.rst Add anchors for individual toc trees. Feb 9, 2017
install_cmake.sh Be more conservative on Travis VMs when compiling CMake. Jan 19, 2017
opencppcoverage_mergereports.bat Codecov (#219) Jul 17, 2017
valgrind_suppressions.txt Relax valgrind memcheck suppressions for ResourceCompilerTest. Feb 19, 2018
valgrindrc Integrated memcheck and helgrind unit tests. Nov 6, 2015

README.rst

Continuous Integration Status

Branch GCC 5.4 and 8.0 Visual Studio 2015  
Xcode 7.3 and 9.4 Visual Studio 2017  
Clang 3.4 and 6.0 MinGW-w64  
master Linux Build Status Windows Build status Code Coverage Status
development Linux Build Status (development) Windows Build status (development) Code Coverage Status (development)

Coverity Scan Build Status

C++ Micro Services

Documentation Status (stable) Documentation Status (development)

Download

Introduction

The C++ Micro Services project is a collection of components for building modular and dynamic service-oriented applications. It is based on OSGi, but tailored to support native cross-platform solutions.

Proper usage of C++ Micro Services patterns and concepts leads to systems with one or more of the following properties:

  • Re-use of software components
  • Loose coupling between service providers and consumers
  • Separation of concerns, based on a service-oriented design
  • Clean APIs based on service interfaces
  • Extensible and reconfigurable systems

Requirements

None, except a recent enough C++ compiler. All third-party library dependencies are included and mostly used for implementation details.

Supported Platforms

The library makes use of C++14 language and library features and compiles on many different platforms.

Recommended minimum required compiler versions:

  • GCC 5.4
  • Clang 3.4
  • Clang from Xcode 8.0
  • Visual Studio 2015

You may use older compilers, but certain functionality may not be available. Check the warnings printed during configuration of your build tree. The following are the absolute minimum requirements:

  • GCC 5.1
  • Clang 3.4
  • Clang from Xcode 7.3
  • Visual Studio 2015 (MSVC++ 14.0)

Below is a list of tested compiler/OS combinations:

  • GCC 5.4 (Ubuntu 14.04) via Travis CI
  • GCC 8.0 (Ubuntu 14.04) via Travis CI
  • Clang 3.4 (Ubuntu 14.04) via Travis CI
  • Clang 6.0 (Ubuntu 14.04) via Travis CI
  • Clang Xcode 7.3 (OS X 10.11) via Travis CI
  • Clang Xcode 9.4 (OS X 10.13) via Travis CI
  • Visual Studio 2015 via Appveyor
  • Visual Studio 2017 via Appveyor
  • MinGW-w64 via Appveyor

Legal

The C++ Micro Services project was initially developed at the German Cancer Research Center. Its source code is hosted as a GitHub Project. 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 :any:`Code of Conduct <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. The framework manages, among other things, logical units of modularity called bundles that are contained in shared or static libraries. Each bundle within a library has an associated :any:`cppmicroservices::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 the :ref:`CONTRIBUTING <contributing>` file for details about the contribution process.