Skip to content

Commit

Permalink
Website update
Browse files Browse the repository at this point in the history
Building for cyclonedds master, changed from commit 565fc6b100c546e5c95b0d57e5fde9b71dd79287 to b53c54a981a1193a430ffb4bb504efef157671ee.
  • Loading branch information
Python cyclonedds.io Builder committed Aug 23, 2024
1 parent d6c5d16 commit 12f0090
Show file tree
Hide file tree
Showing 8 changed files with 39 additions and 20 deletions.
2 changes: 1 addition & 1 deletion database.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"cyclonedds": {
"master_commit": "565fc6b100c546e5c95b0d57e5fde9b71dd79287",
"master_commit": "b53c54a981a1193a430ffb4bb504efef157671ee",
"tags": [
"0.10.5",
"0.8.2",
Expand Down
Binary file not shown.
Binary file modified pages/docs/cyclonedds/latest/.doctrees/environment.pickle
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -2520,11 +2520,23 @@ The default value is: ``<empty>``
//CycloneDDS/Domain/Threads/Thread/Scheduling
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Children: :ref:`Class<//CycloneDDS/Domain/Threads/Thread/Scheduling/Class>`, :ref:`Priority<//CycloneDDS/Domain/Threads/Thread/Scheduling/Priority>`
Children: :ref:`Affinity<//CycloneDDS/Domain/Threads/Thread/Scheduling/Affinity>`, :ref:`Class<//CycloneDDS/Domain/Threads/Thread/Scheduling/Class>`, :ref:`Priority<//CycloneDDS/Domain/Threads/Thread/Scheduling/Priority>`

This element configures the scheduling properties of the thread.


.. _`//CycloneDDS/Domain/Threads/Thread/Scheduling/Affinity`:

//CycloneDDS/Domain/Threads/Thread/Scheduling/Affinity
""""""""""""""""""""""""""""""""""""""""""""""""""""""

Text

This element specifies the thread affinity using a string of comma-separated unsigned 32-bit integers. The notional meaning of the string is that it lists the IDs of the CPU cores to use, but some platforms may use a different mapping. Ignored if unsupported by the platform.

The default value is: ``<empty>``


.. _`//CycloneDDS/Domain/Threads/Thread/Scheduling/Class`:

//CycloneDDS/Domain/Threads/Thread/Scheduling/Class
Expand Down Expand Up @@ -2704,14 +2716,14 @@ The categorisation of tracing output is incomplete and hence most of the verbosi
The default value is: ``none``

..
generated from ddsi_config.h[83ad19f1a665710b0c82b3ac6b861e6c8e83913f]
generated from ddsi_config.h[e6e75c7c07b3b91a92715063cfd8abdd0fbd8b08]
generated from ddsi__cfgunits.h[bd22f0c0ed210501d0ecd3b07c992eca549ef5aa]
generated from ddsi__cfgelems.h[194217161977869610495a7889bbc1e6bc976ce1]
generated from ddsi_config.c[a439a20e32fe327db26f2f10028d0056e46c1a0b]
generated from _confgen.h[e32eabfc35e9f3a7dcb63b19ed148c0d17c6e5fc]
generated from ddsi__cfgelems.h[69679834d0a592a339803ed27e3966adc900d592]
generated from ddsi_config.c[8d7ef0ae962a47cb2138de27ac0f6751e3393c66]
generated from _confgen.h[9554f1d72645c0b8bb66ffbfbc3c0fb664fc1a43]
generated from _confgen.c[237308acd53897a34e8c643e16e05a61d73ffd65]
generated from generate_rnc.c[b50e4b7ab1d04b2bc1d361a0811247c337b74934]
generated from generate_md.c[789b92e422631684352909cfb8bf43f6ceb16a01]
generated from generate_rst.c[3c4b523fbb57c8e4a7e247379d06a8021ccc21c4]
generated from generate_xsd.c[6b6818d7f17a35d56c376c04ec1410427f34c0f0]
generated from generate_defconfig.c[63ca9d8ae2f1ce2e761c9d4c0510a45eb062d830]
generated from generate_defconfig.c[631cafee70a6f9480e0267db8ffe883d806f5f70]
27 changes: 17 additions & 10 deletions pages/docs/cyclonedds/latest/config/config_file_reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -1469,23 +1469,29 @@ <h3 id="searchlabel">Quick search</h3>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">&lt;empty&gt;</span></code></p>
<section id="cyclonedds-domain-threads-thread-scheduling">
<span id="id187"></span><h6>//CycloneDDS/Domain/Threads/Thread/Scheduling<a class="headerlink" href="#cyclonedds-domain-threads-thread-scheduling" title="Permalink to this headline"></a></h6>
<p>Children: <a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-class"><span class="std std-ref">Class</span></a>, <a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-priority"><span class="std std-ref">Priority</span></a></p>
<p>Children: <a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-affinity"><span class="std std-ref">Affinity</span></a>, <a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-class"><span class="std std-ref">Class</span></a>, <a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-priority"><span class="std std-ref">Priority</span></a></p>
<p>This element configures the scheduling properties of the thread.</p>
<section id="cyclonedds-domain-threads-thread-scheduling-affinity">
<span id="id188"></span><h7>//CycloneDDS/Domain/Threads/Thread/Scheduling/Affinity<a class="headerlink" href="#cyclonedds-domain-threads-thread-scheduling-affinity" title="Permalink to this headline"></a></h7>
<p>Text</p>
<p>This element specifies the thread affinity using a string of comma-separated unsigned 32-bit integers. The notional meaning of the string is that it lists the IDs of the CPU cores to use, but some platforms may use a different mapping. Ignored if unsupported by the platform.</p>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">&lt;empty&gt;</span></code></p>
</section>
<section id="cyclonedds-domain-threads-thread-scheduling-class">
<span id="id188"></span><h7>//CycloneDDS/Domain/Threads/Thread/Scheduling/Class<a class="headerlink" href="#cyclonedds-domain-threads-thread-scheduling-class" title="Permalink to this headline"></a></h7>
<span id="id189"></span><h7>//CycloneDDS/Domain/Threads/Thread/Scheduling/Class<a class="headerlink" href="#cyclonedds-domain-threads-thread-scheduling-class" title="Permalink to this headline"></a></h7>
<p>One of: realtime, timeshare, default</p>
<p>This element specifies the thread scheduling class (realtime, timeshare or default). The user may need special privileges from the underlying operating system to be able to assign some of the privileged scheduling classes.</p>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
</section>
<section id="cyclonedds-domain-threads-thread-scheduling-priority">
<span id="id189"></span><h7>//CycloneDDS/Domain/Threads/Thread/Scheduling/Priority<a class="headerlink" href="#cyclonedds-domain-threads-thread-scheduling-priority" title="Permalink to this headline"></a></h7>
<span id="id190"></span><h7>//CycloneDDS/Domain/Threads/Thread/Scheduling/Priority<a class="headerlink" href="#cyclonedds-domain-threads-thread-scheduling-priority" title="Permalink to this headline"></a></h7>
<p>Text</p>
<p>This element specifies the thread priority (decimal integer or default). Only priorities supported by the underlying operating system can be assigned to this element. The user may need special privileges from the underlying operating system to be able to assign some of the privileged priorities.</p>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
</section>
</section>
<section id="cyclonedds-domain-threads-thread-stacksize">
<span id="id190"></span><h6>//CycloneDDS/Domain/Threads/Thread/StackSize<a class="headerlink" href="#cyclonedds-domain-threads-thread-stacksize" title="Permalink to this headline"></a></h6>
<span id="id191"></span><h6>//CycloneDDS/Domain/Threads/Thread/StackSize<a class="headerlink" href="#cyclonedds-domain-threads-thread-stacksize" title="Permalink to this headline"></a></h6>
<p>Number-with-unit</p>
<p>This element configures the stack size for this thread. The default value default leaves the stack size at the operating system default.</p>
<p>The unit must be specified explicitly. Recognised units: B (bytes), kB &amp; KiB (2^10 bytes), MB &amp; MiB (2^20 bytes), GB &amp; GiB (2^30 bytes).</p>
Expand All @@ -1494,17 +1500,17 @@ <h3 id="searchlabel">Quick search</h3>
</section>
</section>
<section id="cyclonedds-domain-tracing">
<span id="id191"></span><h4>//CycloneDDS/Domain/Tracing<a class="headerlink" href="#cyclonedds-domain-tracing" title="Permalink to this headline"></a></h4>
<span id="id192"></span><h4>//CycloneDDS/Domain/Tracing<a class="headerlink" href="#cyclonedds-domain-tracing" title="Permalink to this headline"></a></h4>
<p>Children: <a class="reference internal" href="#cyclonedds-domain-tracing-appendtofile"><span class="std std-ref">AppendToFile</span></a>, <a class="reference internal" href="#cyclonedds-domain-tracing-category"><span class="std std-ref">Category|EnableCategory</span></a>, <a class="reference internal" href="#cyclonedds-domain-tracing-outputfile"><span class="std std-ref">OutputFile</span></a>, <a class="reference internal" href="#cyclonedds-domain-tracing-packetcapturefile"><span class="std std-ref">PacketCaptureFile</span></a>, <a class="reference internal" href="#cyclonedds-domain-tracing-verbosity"><span class="std std-ref">Verbosity</span></a></p>
<p>The Tracing element controls the amount and type of information that is written into the tracing log by the DDSI service. This is useful to track the DDSI service during application development.</p>
<section id="cyclonedds-domain-tracing-appendtofile">
<span id="id192"></span><h5>//CycloneDDS/Domain/Tracing/AppendToFile<a class="headerlink" href="#cyclonedds-domain-tracing-appendtofile" title="Permalink to this headline"></a></h5>
<span id="id193"></span><h5>//CycloneDDS/Domain/Tracing/AppendToFile<a class="headerlink" href="#cyclonedds-domain-tracing-appendtofile" title="Permalink to this headline"></a></h5>
<p>Boolean</p>
<p>This option specifies whether the output should be appended to an existing log file. The default is to create a new log file each time, which is generally the best option if a detailed log is generated.</p>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
</section>
<section id="cyclonedds-domain-tracing-category">
<span id="id193"></span><h5>//CycloneDDS/Domain/Tracing/Category<a class="headerlink" href="#cyclonedds-domain-tracing-category" title="Permalink to this headline"></a></h5>
<span id="id194"></span><h5>//CycloneDDS/Domain/Tracing/Category<a class="headerlink" href="#cyclonedds-domain-tracing-category" title="Permalink to this headline"></a></h5>
<p>One of:
* Comma-separated list of: fatal, error, warning, info, config, discovery, data, radmin, timing, traffic, topic, tcp, plist, whc, throttle, rhc, content, malformed, trace, user, user1, user2, user3
* Or empty</p>
Expand Down Expand Up @@ -1540,19 +1546,19 @@ <h3 id="searchlabel">Quick search</h3>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">&lt;empty&gt;</span></code></p>
</section>
<section id="cyclonedds-domain-tracing-outputfile">
<span id="id194"></span><h5>//CycloneDDS/Domain/Tracing/OutputFile<a class="headerlink" href="#cyclonedds-domain-tracing-outputfile" title="Permalink to this headline"></a></h5>
<span id="id195"></span><h5>//CycloneDDS/Domain/Tracing/OutputFile<a class="headerlink" href="#cyclonedds-domain-tracing-outputfile" title="Permalink to this headline"></a></h5>
<p>Text</p>
<p>This option specifies where the logging is printed to. Note that stdout and stderr are treated as special values, representing “standard out” and “standard error” respectively. No file is created unless logging categories are enabled using the Tracing/Verbosity or Tracing/EnabledCategory settings.</p>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">cyclonedds.log</span></code></p>
</section>
<section id="cyclonedds-domain-tracing-packetcapturefile">
<span id="id195"></span><h5>//CycloneDDS/Domain/Tracing/PacketCaptureFile<a class="headerlink" href="#cyclonedds-domain-tracing-packetcapturefile" title="Permalink to this headline"></a></h5>
<span id="id196"></span><h5>//CycloneDDS/Domain/Tracing/PacketCaptureFile<a class="headerlink" href="#cyclonedds-domain-tracing-packetcapturefile" title="Permalink to this headline"></a></h5>
<p>Text</p>
<p>This option specifies the file to which received and sent packets will be logged in the “pcap” format suitable for analysis using common networking tools, such as WireShark. IP and UDP headers are fictitious, in particular the destination address of received packets. The TTL may be used to distinguish between sent and received packets: it is 255 for sent packets and 128 for received ones. Currently IPv4 only.</p>
<p>The default value is: <code class="docutils literal notranslate"><span class="pre">&lt;empty&gt;</span></code></p>
</section>
<section id="cyclonedds-domain-tracing-verbosity">
<span id="id196"></span><h5>//CycloneDDS/Domain/Tracing/Verbosity<a class="headerlink" href="#cyclonedds-domain-tracing-verbosity" title="Permalink to this headline"></a></h5>
<span id="id197"></span><h5>//CycloneDDS/Domain/Tracing/Verbosity<a class="headerlink" href="#cyclonedds-domain-tracing-verbosity" title="Permalink to this headline"></a></h5>
<p>One of: finest, finer, fine, config, info, warning, severe, none</p>
<dl class="simple">
<dt>This element enables standard groups of categories, based on a desired verbosity level. This is in addition to the categories enabled by the Tracing/Category setting. Recognised verbosity levels and the categories they map to are:</dt><dd><ul class="simple">
Expand Down Expand Up @@ -1820,6 +1826,7 @@ <h3 id="searchlabel">Quick search</h3>
<li><a class="reference internal" href="#cyclonedds-domain-threads-thread">//CycloneDDS/Domain/Threads/Thread</a></li>
<li><a class="reference internal" href="#cyclonedds-domain-threads-thread-name">//CycloneDDS/Domain/Threads/Thread[&#64;Name]</a><ul>
<li><a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling">//CycloneDDS/Domain/Threads/Thread/Scheduling</a><ul>
<li><a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-affinity">//CycloneDDS/Domain/Threads/Thread/Scheduling/Affinity</a></li>
<li><a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-class">//CycloneDDS/Domain/Threads/Thread/Scheduling/Class</a></li>
<li><a class="reference internal" href="#cyclonedds-domain-threads-thread-scheduling-priority">//CycloneDDS/Domain/Threads/Thread/Scheduling/Priority</a></li>
</ul>
Expand Down
Binary file modified pages/docs/cyclonedds/latest/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion pages/docs/cyclonedds/latest/searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions pages/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,11 @@ <h2 class="mb-2">Latest (master branch)</h2>
<div class="col-6 col-md-4 mb-1">
<div class="btn-group">
<a class="btn btn-outline-primary btn-sm" href="/docs/cyclonedds/latest">Documentation</a>
<a class="btn btn-outline-primary btn-sm" href="https://github.com/eclipse-cyclonedds/cyclonedds/tree/565fc6b100c546e5c95b0d57e5fde9b71dd79287">Code</a>
<a class="btn btn-outline-primary btn-sm" href="https://github.com/eclipse-cyclonedds/cyclonedds/tree/b53c54a981a1193a430ffb4bb504efef157671ee">Code</a>
</div>
</div>
<div class="col-12 col-md-6 mb-1">
<span class="text-muted">565fc6b100c546e5c95b0d57e5fde9b71dd79287</span>
<span class="text-muted">b53c54a981a1193a430ffb4bb504efef157671ee</span>
</div>
<div class="col-6 col-md-2 mb-1"><strong>C++</strong></div>
<div class="col-6 col-md-4 mb-1">
Expand Down

0 comments on commit 12f0090

Please sign in to comment.