docs/libamb.in

   1 /**
   2  \mainpage Automotive Message Broker Library Documentation
   3  \version @PROJECT_VERSION@
   4  \section intro Introduction
   5  Automotive Message Broker (AMB) Library documentation outlines the internal classes and structures for building
   6  plugins for AMB.
   7
   8  \section architecture General Architecture
   9  AMB has 3 main parts.  Source plugins which provide data, a routing engine that
  10  routes data and sink plugins that consume the data.
  11
  12  \section properties Properties
  13  AMB defines a number of properties itself.  These properties are defined in vehicleproperty.h.  The DBus plugin
  14  will take many of these properties and combine them in DBus interfaces.  The mappings of AMB internal properties
  15  to DBus Interface properties can be found in the <a href="ambdbusmappings_8idl.html">mappings documentation</a>.  This file will come in handy when you want to
  16  implement a particular AMB DBus interface in your source plugin.
  17
  18  By default, for any property not explicitly
  19  included in a DBus interface, the DBus plugin will generate a custom interface.  The pattern is as follows:
  20
  21  CustomProperty = "org.automotive.CustomProperty.CustomProperty"
  22
  23  "org.automotive.CustomProperty is the DBus interface and CustomProperty is a DBus property in that interface.
  24
  25  \section plugins Plugins
  26  There are two types of plugins: plugins that provide data, called "sources"
  27  (AbstractSource) and plugins that consume data, called "sinks" (AbstractSink).
  28  A typical source would get data from the vehicle and then translate the raw data
  29  into AMB property types.  Sinks then subscribe to the property types and do useful
  30  things with the data.
  31
  32  Example plugins can be found in plugins/exampleplugin.{h,cpp} for an example
  33  source plugin and plugins/examplesink.{h,cpp} for an example sink plugin.  There
  34  are also many different types of plugins useful for testing and development in the
  35  plugins/ directory.
  36
  37  Various plugins have separate documentation found in @DOC_INSTALL_DIR@/plugins/.
  38
  39  \section plugin_creation Creating your own plugin
  40  AMB allows you to create your own plugins.  Plugins inherit from either AbstractSource, AbstractSink, or AmbPluginImpl.
  41
  42  It is recommended that new plugins be written using AmbPlugin and AmbPluginImpl.
  43
  44  \section routing_engine Routing Engine Plugins
  45  As of 0.12, the routing engine itself can be exchanged for a plugin.  This allows
  46  users to swap in routing engines with different behaviors, additional security,
  47  and custom throttling and filtering features.
  48
  49  The easiest way to get started creating a routing engine plugin would be to look at
  50  AbstractRoutingEngine, the base class for all routing engines and the default
  51  routing engine in ambd/core.cpp.
  52 **/