Skip to content

Commit

Permalink
Update some doc files to new product name (eProsima#1725)
Browse files Browse the repository at this point in the history
  • Loading branch information
@richiware
richiware authored Feb 1, 2021
1 parent 70e2ad0 commit f2ec2c9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 20 deletions.
12 changes: 5 additions & 7 deletions doc/README.html.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1236,8 +1236,7 @@
qeDYVtlzxb3CYN/TnYWBLU9ef9z46sOXlcIy5NS29W/fvP/yoirVzPdAfo6bFXJOXBERUavpRCPj
CGRcsajh9IybKq7s67nTHSkv44qS64gFhxlraMgkRmGwF1fP7oZlNk4mEMJCT9pBsRZx+7BFDCZV IiIiotbiDBYRERERAxYRERERAxYRERHRkvIDO779xeTKXgYAAAAASUVORK5CYII=" name="logo" align="bottom" width="240" height="62" border="0"/>
</p>
<p class="western" align="center"><font face="Arial, sans-serif"><font size="5" style="font-size: 20pt"><b>Fast RTPS v@PROJECT_VERSION@</b></font></p>
</td>
<p class="western" align="center"><font face="Arial, sans-serif"><font size="5" style="font-size: 20pt"><b>Fast DDS v@PROJECT_VERSION@</b></font></p> </td>
<td width="33%" style="background: transparent" style="border: none; padding: 0in">
<p class="western" align="right"><font face="Arial, sans-serif"><font size="1" style="font-size: 10pt">Email: <a class="western" href="mailto:[email protected]">[email protected]</a><br/>Phone: +34 91 804 34 48<br/><a class="western" href="http://www.eprosima.com/">www.eprosima.com</a></p>
</td>
Expand All @@ -1254,22 +1253,21 @@
<li/>
<p class="western" style="margin-bottom: 0in"><a class="western" href="@README_LOCATION_PREFFIX@manual/index.html"><font face="Arial, sans-serif" size="3" style="font-size: 12pt">Installation, User Manual and Release notes</font></a></p>
<li/>
<p class="western" style="margin-bottom: 0in"><font face="Arial, sans-serif" size="3" style="font-size: 12pt"><a class="western" href="@README_LOCATION_PREFFIX@api_reference/index.html"><i>eProsima Fast RTPS</i> C++ API html documentation</a></font></p>
</ul>
<p class="western" style="margin-bottom: 0in"><font face="Arial, sans-serif" size="3" style="font-size: 12pt"><a class="western" href="@README_LOCATION_PREFFIX@api_reference/index.html"><i>eProsima Fast DDS</i> C++ API html documentation</a></font></p> </ul>
<p class="western" style="margin-bottom: 0in"><br/></p>
<p class="western" style="margin-bottom: 0in"><font face="Arial, sans-serif" size="3" style="font-size: 12pt"><b>Online (updated frequently):</b></font></p>
<p class="western" style="margin-bottom: 0in; font-variant: normal; letter-spacing: normal; font-style: normal; font-weight: normal"><br/></p>
<ul>
<li/>
<p class="western" style="margin-bottom: 0in"><font color="#000000" face="Arial, sans-serif" size="3" style="font-size: 12pt">Installation, User Manual and Release notes. (<a class="western" href="https://fast-dds.docs.eprosima.com">https://fast-dds.docs.eprosima.com</a>)</font></p>
<li/>
<p class="western" style="margin-bottom: 0in"><font color="#000000" face="Arial, sans-serif" size="3" style="font-size: 12pt"><i>eProsima Fast RTPS</i> C++ API html documentation. (<a class="western" href="https://fast-dds.docs.eprosima.com/en/latest/fastdds/api_reference/api_reference.html">https://fast-dds.docs.eprosima.com/en/latest/fastdds/api_reference/api_reference.html</a>)</font></p>
<p class="western" style="margin-bottom: 0in"><font color="#000000" face="Arial, sans-serif" size="3" style="font-size: 12pt"><i>eProsima Fast DDS</i> C++ API html documentation. (<a class="western" href="https://fast-dds.docs.eprosima.com/en/latest/fastdds/api_reference/api_reference.html">https://fast-dds.docs.eprosima.com/en/latest/fastdds/api_reference/api_reference.html</a>)</font></p>
<li/>
<p class="western" style="margin-bottom: 0in"><font color="#000000" face="Arial, sans-serif" size="3" style="font-size: 12pt">Product Page: Video Tutorials, Whitepapers, benchmarkings (<a class="western" href="http://www.eprosima.com/index.php/products-all/eprosima-fast-rtps">http://www.eprosima.com/index.php/products-all/eprosima-fast-rtps</a>)</font></p>
<p class="western" style="margin-bottom: 0in"><font color="#000000" face="Arial, sans-serif" size="3" style="font-size: 12pt">Product Page: Video Tutorials, Whitepapers, benchmarkings (<a class="western" href="http://www.eprosima.com/index.php/products-all/eprosima-fast-dds">http://www.eprosima.com/index.php/products-all/eprosima-fast-dds</a>)</font></p>
</ul>
<p class="western" style="margin-bottom: 0in"><br/></p>
<p class="western" style="margin-bottom: 0in; border-top: none; border-bottom: 1px solid #000000; border-left: none; border-right: none; padding-top: 0in; padding-bottom: 0.03in; padding-left: 0in; padding-right: 0in"><br/></p>
<p class="western" style="margin-bottom: 0in"><font face="Arial, sans-serif" size="2" style="font-size: 11pt"><b>Copyright&copy; 2019 eProsima. All rights reserved.</b></font></p>
<p class="western" style="margin-bottom: 0in"><font face="Arial, sans-serif" size="2" style="font-size: 11pt">This copy of <i>eProsima Fast RTPS</i> is licensed to you under the terms described in the LICENSE file included in this distribution.</font></p>
<p class="western" style="margin-bottom: 0in"><font face="Arial, sans-serif" size="2" style="font-size: 11pt">This copy of <i>eProsima Fast DDS</i> is licensed to you under the terms described in the LICENSE file included in this distribution.</font></p>
</body>
</html>
26 changes: 13 additions & 13 deletions utils/doxygen/pages/mainpage.dox
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
/*!
* @mainpage eProsima Fast RTPS library.
* @mainpage eProsima Fast DDS library.
* <div id="mainpage" style="width:95%;text-align:justify;text-justify:inter-word">
* <h1>Purpose</h1>
* Real-Time Publish-Subscribe (RTPS) is the wire interoperability protocol defined for the Data-Distribution Service (DDS) standard by
*the Object Management Group (OMG) consortium. This protocol standard is also defined by the OMG in the specification document
*“The Real-Time Publish-Subscribe Wire Protocol. DDS Interoperability Wire Protocol Specification (DDS-RTPS)” that can
*be obtained from the OMG web-page. The main objective of this specification is that all RTPSParticipants in a DDS communication
* Real-Time Publish-Subscribe (RTPS) is the wire interoperability protocol defined for the Data-Distribution Service (DDS) standard by
*the Object Management Group (OMG) consortium. This protocol standard is also defined by the OMG in the specification document
*“The Real-Time Publish-Subscribe Wire Protocol. DDS Interoperability Wire Protocol Specification (DDS-RTPS)” that can
*be obtained from the OMG web-page. The main objective of this specification is that all RTPSParticipants in a DDS communication
*structure, even if they use different vendor's implementations, can interoperate.
* <br/><br/>
*<h1>Scope</h1>
* The scope of this implementation is going to be limited by the RTPS protocol specification of the OMG. Since the main purpose
*of this design is to facilitate the implementation of a standalone RTPS wire protocol as close to the specification as possible,
*the included features will be the ones described in the OMG document. The OMG specification defines message formats, interpretation
* The scope of this implementation is going to be limited by the RTPS protocol specification of the OMG. Since the main purpose
*of this design is to facilitate the implementation of a standalone RTPS wire protocol as close to the specification as possible,
*the included features will be the ones described in the OMG document. The OMG specification defines message formats, interpretation
*and usage scenarios for any application willing to use RTPS protocol
* The most important features are:
*<ul>
Expand All @@ -23,7 +23,7 @@
*<h1>System architecture</h1>
* A general view of the system architecture can be found below:
* <img src="general_architecture.png" width="400" align="left" style="padding:0px 20px 0px 0px">
* The Fast RTPS library provides the user with two different layers to access its capabilities. The first is the RTPS layer, contained in the
* The Fast DDS library provides the user with two different layers to access its capabilities. The first is the RTPS layer, contained in the
* RTPSDomain. Using this layer, the user can directly create RTPSWriter and RTPSReader type objects and access their
* corresponding Histories. To facilitate the use of this layer an additional Publication-Subscription layer has
* been developed. This second layer allows the user to create Publishers and Subscribers associated to certain topics and
Expand All @@ -34,22 +34,22 @@ The correct behavior of the RTPS protocol will be achieved by using an event-bas
<br/>
<h3>Thread Structure</h3>
For each RTPSParticipant, various threads will be spawned to manage different aspects of the RTPS implementation. Each application using this implementation will at least have the following threads:
<ul><li><b>Main thread:</b> This will be the thread managed by the application or the user. The user will interact with the objects through the defined public APIs.
<ul><li><b>Main thread:</b> This will be the thread managed by the application or the user. The user will interact with the objects through the defined public APIs.
<li><b>Receive thread:</b> These threads will be in charge of listening to the different ports. Since these threads will be blocked until a RTPS message is received there will be a different thread for each different IP-port combination that the RTPSParticipant is listening from. Multiple endpoints can be assigned to the same listening thread.
<li><b>Event thread(s):</b> This thread will be in charge of processing events triggered by some periodic condition, or by actions performed by the user in the main thread. In this version a single event thread will be created and used per RTPSParticipant.
</ul>

<h3>Resource Structure</h3>
There are three main types of resources in the implementation, that directly correspond with three classes. All resources are managed by the RTPSParticipant.
<ul><li><b>ResourceListen:</b> Each listen resource is assigned to a single IP:port combination. It receives and processes messages directed to that socket and performs the necessary actions in one or more of the associated Writers or Readers. In this version each ResourceListen runs a single thread listening to a single socket. Future versions may allow the association of multiple sockets (multiple ResourceListen objects) with a single listen thread.
<li><b>ResourceEvent: </b> This resource manages the time-delayed event triggered periodically or by some message-based event. A single resource is implemented per RTPSParticipant, with a single thread performing all the actions. Future versions may include multiple ResourceEvents running in multiple threads to improve performance.
<ul><li><b>ResourceListen:</b> Each listen resource is assigned to a single IP:port combination. It receives and processes messages directed to that socket and performs the necessary actions in one or more of the associated Writers or Readers. In this version each ResourceListen runs a single thread listening to a single socket. Future versions may allow the association of multiple sockets (multiple ResourceListen objects) with a single listen thread.
<li><b>ResourceEvent: </b> This resource manages the time-delayed event triggered periodically or by some message-based event. A single resource is implemented per RTPSParticipant, with a single thread performing all the actions. Future versions may include multiple ResourceEvents running in multiple threads to improve performance.
<li><b>Event thread(s):</b> This resource manages ALL send operations in the RTPSParticipant. This means that all endpoints included in an RTPSParticipant send their messages through the socket defined in this resource. All messages are send synchronously. Future versions will include multiple ResourceSend objects and the possibility to asynchronously send messages.
</ul>


<h3> Main events</h3>
There are multiple events that are triggered wither directly by some action performed by the user, the reception of messages or even periodically. A list of the main events and the actions that need to be performed after them is included below, whereas a detailed description of all the events associated with each class of the design will be included in the detailed implementation chapter.
<ul><li><b>User-triggered events:</b> These events are triggered directly after the user performs some action, either directly to the RTPS Writer or its associated HistoryCache.
<ul><li><b>User-triggered events:</b> These events are triggered directly after the user performs some action, either directly to the RTPS Writer or its associated HistoryCache.
<li><b>Message-triggered events:</b> These events are triggered by the reception of an RTPS message. For example, the reception of an ACKNACK message would trigger a change in the status of some CacheChanges in the HistoryCache and, maybe, the re-send of some packets to a specific Reader.
<li><b>Periodic events:</b> Some events must be triggered periodically according to DDS rules. For example, heartbeat packets must be send each heartbeatPeriod to all matching Readers.
</ul>
Expand Down

0 comments on commit f2ec2c9

Please sign in to comment.