Directory Structure

The source shipped with RTI Connext DDS Micro is identical to the source developed and tested by RTI (with the exception of the the line-endings difference between the Unix and Windows source-bundles).

The source-bundle directory structure is as follows:

 RTIMEHOME--+-- source --+-- Unix ------+----- CmakeLists.txt
                         |              |
                         |              +--+-- include
                         |              | 
                         |              +--+-- src
                         |              |
                         |              +--+-- resource --+-- cmake 
                         |              |                 |
                         |              |                 +-- scripts
                         |              | 
                         |              +--+-- lib +-- <ARCH> -- <libraries>
                         |              
                         +-- windows ---+----- CMakeLists.txt.txt
                                        |
                                        +--+-- include
                                        | 
                                        +--+-- src
                                        |
                                        +--+-- resource --+-- cmake --+
                                        |                 |
                                        |                 +-- scripts --+
                                        | 
                                        +--+-- lib +-- <ARCH> -- <libraries>

The include directory contains the external interfaces, those that are available to other modules. The src directory contains the implementation files. Please refer to Building the RTI Connext DDS Micro Source for how to build the source code.

This remainder of this document focuses on the files that are needed to add a new port. The following directory structure is expected:

 ---+-- include --+-- osapi --+-- osapi_os_\<port\>.h
    |                         |
    |                         +-- osapi_cc_<compiler>.h
    | 
    +-- src --+-- osapi --+-- common -- <common files> 
                          |
                          +-- <port> --+-- <port>Heap.c
                                       |
                                       +-- <port>Mutex.c
                                       |
                                       +-- <port>Process.c
                                       |
                                       +-- <port>Semaphore.c
                                       |
                                       +-- <port>String.c
                                       |
                                       +-- <port>System.c

The osapi_os_<port>.h file contains OS specific definitions for various data-types. The <port> name should be short and in lower case, for example myos .

The osapi_cc_<compiler>.h file contains compiler specific definitions. The <compiler> name should be short and in lower case, for example mycc . The osapi_cc_stdc.h files properly detects GCC and MSVC and it is not necessary to provide a new file if one of these compilers are used.

The <port>Heap.c, <port>Mutex.c, <port>Process.c, <port>Semaphore.c, <port>String.c and <port>System.c files shall contain the implementation of the required APIs.

NOTE: It is not recommended to modify source files shipped with RTI Connext DDS Micro. Instead if it is desired to start with code supplied by RTI it is recommended to copy the corresponding sub-directory, for example posix, and rename it. This way it is easier to upgrade RTI Connext DDS Micro while keeping existing ports.