Welcome to shared_memory’s documentation!

Readme

what it is

• This library is a convenient wrapper over boost:interprocess. It is meant to be trivial to use, and to make interprocess communication between processes trivial

• It is meant to be realtime friendly (no dynamic allocation)

how it works / API

An example covering the complete API is in src/examples . You may run the related executables.

how to run the unit tests

colcon build
colcon test

After the tests have run, use the following to get an overview of the results:

colcon test-result

Add --verbose to get more information in case there were failures.

Limitations

• There must be in the code a “manual” cleanup of the memory. See for example: set_data

• Arrays, map and vectors are expected to be of a predefined fixed size. Even when using the ‘get’ methods, they are expected to have been declared with the correct size (and with the correct set of keys for maps)

Removing shared memory file

On linux, the shared memory mappings are created under /dev/shm. If necessary (e.g. if a program was creating the shared memory with the wrong permissions), these files can be delted manually.

C++ API

• C++ API
  • Class list
  • File list
  • Namespace list
  • Struct list
  • C++ API and example

Indices and Tables

• Index

• Search Page

License and Copyrights

BSD 3-Clause License

Copyright (c) 2019, New York University and Max Planck Gesellschaft. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.