qt6-migration-pipeline/external/rti_connext_dds-7.7.0/doc/api/persistence_service/index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RTI Persistence Service: RTI Persistence Service for RTI Connext Messaging</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">RTI Persistence Service<span id="projectnumber">&#160;Version 7.7.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">RTI Persistence Service for RTI Connext Messaging </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="image">
<img src="rti_logo.gif" alt=""/>
</div>
<center><a href="http://www.rti.com">Real-Time Innovations, Inc.</a></center><h1><a class="anchor" id="document"></a>
Available Documentation</h1>
<p >This document contains: </p><ul>
<li><a class="el" href="index.html#overview">Overview</a> </li>
<li><a class="el" href="index.html#usage">Using RTI Persistence Service</a> </li>
<li><a class="el" href="index.html#running">Running RTI Persistence Service</a> </li>
<li><a class="el" href="index.html#persistence_library">Using the RTI Persistence Service as a Library</a></li>
</ul>
<p>For additional information, please see the following PDF documents:</p>
<ul>
<li><b><a href="../../manuals/connext_dds_professional/services/persistence_service/release_notes/RTI_Persistence_Service_ReleaseNotes.pdf" target="_blank">RTI Persistence Service Release Notes</a></b></li>
<li><b><a href="../../manuals/connext_dds_professional/users_manual/RTI_ConnextDDS_CoreLibraries_UsersManual.pdf" target="_blank">Core Libraries User's Manual</a></b> (RTI Persistence Service section)</li>
</ul>
<p >Please do not hesitate to contact RTI with questions or comments about this release. We welcome any input on how to improve RTI Persistence Service to suit your needs.</p>
<p ><br  />
</p>
<h1><a class="anchor" id="overview"></a>
Overview</h1>
<p >RTI Persistence Service is an optional package that saves data samples so that they can be delivered to subscribing applications that join the system at a later time &ndash; even if the publishing application has already terminated.</p>
<p >RTI Persistence Service runs as a separate application; you can run it on the same node as the publishing application, the subscribing application, or some other node in the network.</p>
<p >When configured to run in PERSISTENT mode, RTI Persistence Service uses the filesystem to persist data samples. For each persistent topic, it collects all the data written by the corresponding persistent DataWriters and stores them into persistent storage.</p>
<p >When configured to run in TRANSIENT mode, RTI Persistence Service stores the data in memory.</p>
<p ><br  />
</p>
<h1><a class="anchor" id="usage"></a>
Using RTI Persistence Service</h1>
<p >To use RTI Persistence Service in your RTI Connext Messaging application, you need to modify the <b>DURABILITY QosPolicy</b> of the DataReader and/or DataWriter. You may optionally modify the <b>DURABILITY_SERVICE QosPolicy</b>, which can be used to configure RTI Persistence Service.</p>
<p >For more information, please see <a href="../../manuals/connext_dds_professional/users_manual/users_manual/PartPersistence.htm" target="_blank">RTI Persistence Service</a>, in the Core Libraries User's Manual.</p>
<p ><br  />
</p>
<h1><a class="anchor" id="running"></a>
Running RTI Persistence Service</h1>
<p >You can run RTI Persistence Service on any node in the network; it does not have to be run on the same node as the publishing or subscribing applications for which it is saving/delivering data. If you run RTI Persistence Service on a separate node, however, make sure that the other applications can find it during the discovery process &ndash; that is, it must be in one of the <b>NDDS_DISCOVERY_PEERS</b> lists.</p>
<p >A script to run the RTI Persistence Service executable is located in <b>$NDDSHOME/bin</b>.</p>
<p >For details, see <a href="../../manuals/connext_dds_professional/users_manual/users_manual/PersistenceStartAndStop.htm" target="_blank">Running RTI Persistence Service</a>, in the Core Libraries User's Manual.</p>
<p ><br  />
</p>
<h1><a class="anchor" id="examples"></a>
Finding Example Applications</h1>
<p >A simple example is available to show the how data can be persisted with RTI Persistence Service.</p>
<p ><b>C:</b> See the example in &lt;path to examples&gt;/persistence_service/c/hello_world_persistence.</p>
<p ><b>C++:</b> See the example in &lt;path to examples&gt;/persistence_service/c++/hello_world_persistence.</p>
<p ><b>Java:</b> See the example in &lt;path to examples&gt;/persistence_service/java/hello_world_persistence.</p>
<p >"path to examples" is your rti_workspace directory, which is in your Windows documents folder, Linux home/&lt;your user name&gt; directory, or macOS Users/&lt;your user name&gt; directory.</p>
<p ><br  />
</p>
<h1><a class="anchor" id="configuring_persistence"></a>
Configuring RTI Persistence Service</h1>
<p >See <a href="../../manuals/connext_dds_professional/users_manual/users_manual/PersistenceConfiguration.htm" target="_blank">Configuring Persistence Service</a>, in the Core Libraries User's Manual, for complete information.</p>
<p ><br  />
</p>
<h1><a class="anchor" id="persistence_library"></a>
Using the RTI Persistence Service as a Library</h1>
<p >Persistence can be deployed as a C library linked into your application in selected architectures.</p>
<p >Refer to the <a href="../../manuals/connext_dds_professional/platform_notes/platform_notes/PlatformNotes_Title.htm" target="_blank">Platform Notes</a> for the list of supported architectures.</p>
<p >You can configure, start, and stop the service using the API described here:</p>
<ul>
<li><a class="el" href="group__RTI__PersistenceServiceLibModule.html">Library API</a> </li>
</ul>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
        <footer id="rti-footer">
            <IMG SRC="rti_logo.gif" height="16">
            <A HREF="index.html">RTI Persistence Service Version 7.7.0</A>
            Copyright &copy; Tue Apr 7 2026
            <A HREF="http://www.rti.com">Real-Time Innovations, Inc</A>
        </footer>
    </BODY>
</HTML>