Skip to content

Commit

Permalink
(Commit by workflow script) Update generated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Mar 26, 2024
1 parent 23b3661 commit 27199ee
Show file tree
Hide file tree
Showing 1,339 changed files with 3,253 additions and 3,258 deletions.
4 changes: 2 additions & 2 deletions doc/ipc_doc/generated/html_full/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -132,7 +132,7 @@ <h2>Future directions of work </h2>
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
10 changes: 5 additions & 5 deletions doc/ipc_doc/generated/html_full/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -171,9 +171,9 @@
<tr id="row_1_2_2_7_0_" class="even" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html" target="_self">Config</a></td><td class="desc">Implements <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__reader_1_1Config.html" title="Analogous to Struct_builder::Config but for deserialization.">Struct_reader::Config</a> sub-concept </td></tr>
<tr id="row_1_2_2_8_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__in.html" target="_self">Msg_in</a></td><td class="desc">A structured in-message <em>instance</em> suitable as received and emittable (to user) by <a class="el" href="classipc_1_1transport_1_1struc_1_1Channel.html" title="Owning and wrapping a pre-connected transport::Channel peer (an endpoint of an established channel ov...">struc::Channel</a> </td></tr>
<tr id="row_1_2_2_9_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__in__impl.html" target="_self">Msg_in_impl</a></td><td class="desc">Internally used (data-free) addendum on-top of <a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__in.html" title="A structured in-message instance suitable as received and emittable (to user) by struc::Channel.">Msg_in</a> which makes the <code>protected</code> API public instead </td></tr>
<tr id="row_1_2_2_10_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html" target="_self">Msg_mdt_out</a></td><td class="desc">Internally used (data-free) addendum on-top of <a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send().">Msg_out</a>; really an alias to <code><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send().">Msg_out</a>&lt;schema::detail::StructuredMessage&gt;</code>, where the latter is the internal-use set of metadata schema, with a convenience public mutating API wrapping around capnp-generated mutator API for things like message ID </td></tr>
<tr id="row_1_2_2_11_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" target="_self">Msg_out</a></td><td class="desc">A structured out-message suitable to be sent via <a class="el" href="classipc_1_1transport_1_1struc_1_1Channel.html#ae645cb58ad9ea6374970f1f32c5da448" title="In the synchronous/non-blocking manner of Blob_sender::send_blob() or Native_handle_sender::send_nati...">struc::Channel::send()</a> </td></tr>
<tr id="row_1_2_2_12_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out__impl.html" target="_self">Msg_out_impl</a></td><td class="desc">Internally used (data-free) addendum on-top of <a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send().">Msg_out</a> which makes the <code>protected</code> API public instead </td></tr>
<tr id="row_1_2_2_10_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html" target="_self">Msg_mdt_out</a></td><td class="desc">Internally used (data-free) addendum on-top of <a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send() (et al).">Msg_out</a>; really an alias to <code><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send() (et al).">Msg_out</a>&lt;schema::detail::StructuredMessage&gt;</code>, where the latter is the internal-use set of metadata schema, with a convenience public mutating API wrapping around capnp-generated mutator API for things like message ID </td></tr>
<tr id="row_1_2_2_11_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" target="_self">Msg_out</a></td><td class="desc">A structured out-message suitable to be sent via <a class="el" href="classipc_1_1transport_1_1struc_1_1Channel.html#ae645cb58ad9ea6374970f1f32c5da448" title="In the synchronous/non-blocking manner of Blob_sender::send_blob() or Native_handle_sender::send_nati...">struc::Channel::send()</a> (et al) </td></tr>
<tr id="row_1_2_2_12_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out__impl.html" target="_self">Msg_out_impl</a></td><td class="desc">Internally used (data-free) addendum on-top of <a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send() (et al).">Msg_out</a> which makes the <code>protected</code> API public instead </td></tr>
<tr id="row_1_2_2_13_" class="even" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structipc_1_1transport_1_1struc_1_1Null__session.html" target="_self">Null_session</a></td><td class="desc">Value for <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html#ab90424897efed06ffc6b0884761fb31f" title="Type objects of which specify to emit_serialization() the opposing recipient for which the serializat...">Struct_builder::Session</a> when no extra information is needed when serializing <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> for subsequent sending to another process </td></tr>
<tr id="row_1_2_2_14_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span id="arr_1_2_2_14_" class="arrow" onclick="toggleFolder('1_2_2_14_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" target="_self">Struct_builder</a></td><td class="desc">A documentation-only <em>concept</em> defining the behavior of an object capable of zero-copy-serializing, similar to <code>capnp::MessageBuilder</code> but geared to transmission over pipe-like IPC transports </td></tr>
<tr id="row_1_2_2_14_0_" class="even" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" target="_self">Config</a></td><td class="desc">Copy-ctible, copy-assignable, default-ctible type &ndash; informally, cheaply copyable and likely an <em>aggregate</em> <code>struct</code> &ndash; objects of which store data that <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> main ctor knows how to interpret as knobs controlling its behavior </td></tr>
Expand Down Expand Up @@ -241,7 +241,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:28 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:36 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
6 changes: 3 additions & 3 deletions doc/ipc_doc/generated/html_full/api_overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -501,7 +501,7 @@ <h2>Transport (unstructured) </h2>
</ul>
</li>
</ul>
<p >For Cap'n Proto enthusiasts, <a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send().">ipc::transport::struc::Msg_out</a> provides a couple ways of structuring your message-filling in addition to the vanilla way shown in the example above.</p><ul>
<p >For Cap'n Proto enthusiasts, <a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send() (et al).">ipc::transport::struc::Msg_out</a> provides a couple ways of structuring your message-filling in addition to the vanilla way shown in the example above.</p><ul>
<li><code>Msg_out::orphanage()</code> lets one operate a capnp <em>orphanage</em>. You can build things there in bottom-up fashion and then <code>...adopt....()</code> them into the root message.</li>
<li>Construct <code>Msg_out</code> explicitly, by giving it an existing <code>capnp::MessageBuilder</code>. This allows for completely arbitrary Cap'n Proto mutation work, without having to use any orphanage.</li>
</ul>
Expand Down Expand Up @@ -681,7 +681,7 @@ <h2>Safety </h2>
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
4 changes: 2 additions & 2 deletions doc/ipc_doc/generated/html_full/app_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -112,7 +112,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
4 changes: 2 additions & 2 deletions doc/ipc_doc/generated/html_full/app_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -235,7 +235,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
4 changes: 2 additions & 2 deletions doc/ipc_doc/generated/html_full/app_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -102,7 +102,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
4 changes: 2 additions & 2 deletions doc/ipc_doc/generated/html_full/app_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -383,7 +383,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
4 changes: 2 additions & 2 deletions doc/ipc_doc/generated/html_full/arena__activator_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -98,7 +98,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -193,7 +193,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -169,7 +169,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af246ab80f7fcbde0ef7185b1
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -754,7 +754,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.1</span>
</div>
<div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
</td>
Expand Down Expand Up @@ -109,7 +109,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 20 2024 06:27:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Tue Mar 26 2024 02:49:35 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Loading

0 comments on commit 27199ee

Please sign in to comment.