Communication Middleware (mw::com)
==================================

Welcome to the documentation for Communication Middleware (mw::com),
including the LoLa (Low Latency) implementation and Message Passing library.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   introduction
   README
   message_passing
   how_to_document

.. toctree::
   :maxdepth: 2
   :caption: Public API Documentation:

   generated/api_index
.. Note: Above line is added to capture autogenerated RST files generated by generate_api_rst rule.
.. If output_dir is changed in generate_api_rst() rule, please update the path accordingly.

.. toctree::
   :maxdepth: 2
   :caption: Safety Documentation:

   safety_reports

.. toctree::
   :maxdepth: 1
   :caption: Quality Reports:

   quality_reports

.. Note: safety_reports.rst contains links to pre-built HTML reports from external targets.

About This Documentation
========================

This documentation covers:

* **mw::com / LoLa**: High-level communication middleware implementing parts of Adaptive AUTOSAR Communication Management
* **Message Passing**: Low-level message-passing implementation for high-performance IPC
* **How To Document**: User guide for auto-generated documentation from C++ source code
* **Public API Reference**: Auto-generated API documentation for public i.e. @api tagged mw::com interfaces

Key Features
------------

* Zero-copy shared-memory based communication
* Support for Linux (POSIX) and QNX platforms
* Type-safe message passing
* Real-time capable with deterministic performance

.. code-block:: cpp

   // Create a client connection
   auto client = create_client_connection("/tmp/service");

   // Send a message
   client->send(MyMessage{.data = 42});


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`