Skip to content

Commit 2f63cb9

Browse files
committed
Minor sample code updates. Doxygen update.
1 parent 749ef96 commit 2f63cb9

File tree

108 files changed

+2353
-749
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+2353
-749
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ Alternative asynchronous implementations similar in concept to DelegateMQ, simpl
128128
129129
Repositories utilizing the DelegateMQ library.
130130
131+
* <a href="https://github.com/endurodave/StateMachineWithModernDelegates">C++ State Machine with Asynchronous Delegates</a> - a framework combining a C++ state machine with the asynchronous delegate library.
131132
* <a href="https://github.com/endurodave/AsyncStateMachine">Asynchronous State Machine Design in C++</a> - an asynchronous C++ state machine implemented using an asynchronous delegate library.
132133
* <a href="https://github.com/endurodave/IntegrationTestFramework">Integration Test Framework using Google Test and Delegates</a> - a multi-threaded C++ software integration test framework using Google Test and DelegateMQ libraries.
133134
* <a href="https://github.com/endurodave/Async-SQLite">Asynchronous SQLite API using C++ Delegates</a> - an asynchronous SQLite wrapper implemented using an asynchronous delegate library.

docs/DETAILS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Include `DelegateMQ.h` to use the delegate library features. Build and execute t
182182

183183
# Quick Start
184184

185-
Simple delegate examples showing basic functionality.
185+
Simple delegate examples showing basic functionality. See [Sample Projects](#sample-projects) for more sample code.
186186

187187
## Basic Examples
188188

@@ -1770,6 +1770,7 @@ The table below summarizes the various asynchronous function invocation implemen
17701770
17711771
Repositories utilizing the DelegateMQ library within different multithreaded applications.
17721772
1773+
* <a href="https://github.com/endurodave/StateMachineWithModernDelegates">C++ State Machine with Asynchronous Delegates</a> - a framework combining a C++ state machine with the asynchronous delegate library.
17731774
* <a href="https://github.com/endurodave/AsyncStateMachine">Asynchronous State Machine Design in C++</a> - an asynchronous C++ state machine implemented using an asynchronous delegate library.
17741775
* <a href="https://github.com/endurodave/IntegrationTestFramework">Integration Test Framework using Google Test and Delegates</a> - a multi-threaded C++ software integration test framework using Google Test and Delegate libraries.
17751776
* <a href="https://github.com/endurodave/Async-SQLite">Asynchronous SQLite API using C++ Delegates</a> - an asynchronous SQLite wrapper implemented using an asynchronous delegate library.

docs/html/_delegate_async_wait_8h_source.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@
334334
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno"> 350</span> <span class="keywordflow">return</span> GetRetVal();</div>
335335
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno"> 351</span> } <span class="keywordflow">else</span> {</div>
336336
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno"> 352</span> <span class="comment">// Return a default return value</span></div>
337-
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno"> 353</span> <span class="keywordflow">return</span> RetType{};</div>
337+
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno"> 353</span> <span class="keywordflow">return</span> RetType();</div>
338338
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno"> 354</span> }</div>
339339
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno"> 355</span> }</div>
340340
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno"> 356</span> }</div>
@@ -395,7 +395,7 @@
395395
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno"> 427</span> <span class="keywordflow">return</span> std::any_cast&lt;RetType&gt;(m_retVal);</div>
396396
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno"> 428</span> }</div>
397397
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno"> 429</span> <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::bad_any_cast&amp;) {</div>
398-
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> <span class="keywordflow">return</span> RetType{}; <span class="comment">// Return a default value if error</span></div>
398+
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> <span class="keywordflow">return</span> RetType(); <span class="comment">// Return a default value if error</span></div>
399399
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno"> 431</span> }</div>
400400
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno"> 432</span> }</div>
401401
</div>
@@ -637,7 +637,7 @@
637637
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno"> 753</span> <span class="keywordflow">return</span> GetRetVal();</div>
638638
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno"> 754</span> } <span class="keywordflow">else</span> {</div>
639639
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno"> 755</span> <span class="comment">// Return a default return value</span></div>
640-
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno"> 756</span> <span class="keywordflow">return</span> RetType{};</div>
640+
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno"> 756</span> <span class="keywordflow">return</span> RetType();</div>
641641
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno"> 757</span> }</div>
642642
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno"> 758</span> }</div>
643643
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno"> 759</span> }</div>
@@ -698,7 +698,7 @@
698698
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno"> 830</span> <span class="keywordflow">return</span> std::any_cast&lt;RetType&gt;(m_retVal);</div>
699699
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno"> 831</span> }</div>
700700
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno"> 832</span> <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::bad_any_cast&amp;) {</div>
701-
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno"> 833</span> <span class="keywordflow">return</span> RetType{}; <span class="comment">// Return a default value if error</span></div>
701+
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno"> 833</span> <span class="keywordflow">return</span> RetType(); <span class="comment">// Return a default value if error</span></div>
702702
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno"> 834</span> }</div>
703703
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno"> 835</span> }</div>
704704
</div>
@@ -892,7 +892,7 @@
892892
<div class="line"><a id="l01075" name="l01075"></a><span class="lineno"> 1075</span> <span class="keywordflow">return</span> GetRetVal();</div>
893893
<div class="line"><a id="l01076" name="l01076"></a><span class="lineno"> 1076</span> } <span class="keywordflow">else</span> {</div>
894894
<div class="line"><a id="l01077" name="l01077"></a><span class="lineno"> 1077</span> <span class="comment">// Return a default return value</span></div>
895-
<div class="line"><a id="l01078" name="l01078"></a><span class="lineno"> 1078</span> <span class="keywordflow">return</span> RetType{};</div>
895+
<div class="line"><a id="l01078" name="l01078"></a><span class="lineno"> 1078</span> <span class="keywordflow">return</span> RetType();</div>
896896
<div class="line"><a id="l01079" name="l01079"></a><span class="lineno"> 1079</span> }</div>
897897
<div class="line"><a id="l01080" name="l01080"></a><span class="lineno"> 1080</span> }</div>
898898
<div class="line"><a id="l01081" name="l01081"></a><span class="lineno"> 1081</span> }</div>
@@ -953,7 +953,7 @@
953953
<div class="line"><a id="l01152" name="l01152"></a><span class="lineno"> 1152</span> <span class="keywordflow">return</span> std::any_cast&lt;RetType&gt;(m_retVal);</div>
954954
<div class="line"><a id="l01153" name="l01153"></a><span class="lineno"> 1153</span> }</div>
955955
<div class="line"><a id="l01154" name="l01154"></a><span class="lineno"> 1154</span> <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::bad_any_cast&amp;) {</div>
956-
<div class="line"><a id="l01155" name="l01155"></a><span class="lineno"> 1155</span> <span class="keywordflow">return</span> RetType{}; <span class="comment">// Return a default value if error</span></div>
956+
<div class="line"><a id="l01155" name="l01155"></a><span class="lineno"> 1155</span> <span class="keywordflow">return</span> RetType(); <span class="comment">// Return a default value if error</span></div>
957957
<div class="line"><a id="l01156" name="l01156"></a><span class="lineno"> 1156</span> }</div>
958958
<div class="line"><a id="l01157" name="l01157"></a><span class="lineno"> 1157</span> }</div>
959959
</div>

docs/html/_delegate_m_q_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
<a href="#details">More...</a></p>
105105
<div class="textblock"><code>#include &quot;<a class="el" href="_delegate_opt_8h_source.html">delegate/DelegateOpt.h</a>&quot;</code><br />
106106
<code>#include &quot;<a class="el" href="_multicast_delegate_safe_8h_source.html">delegate/MulticastDelegateSafe.h</a>&quot;</code><br />
107-
<code>#include &quot;<a class="el" href="_unicast_delegate_8h_source.html">delegate/UnicastDelegate.h</a>&quot;</code><br />
107+
<code>#include &quot;<a class="el" href="_unicast_delegate_safe_8h_source.html">delegate/UnicastDelegateSafe.h</a>&quot;</code><br />
108108
<code>#include &quot;<a class="el" href="_delegate_async_8h_source.html">delegate/DelegateAsync.h</a>&quot;</code><br />
109109
<code>#include &quot;<a class="el" href="_delegate_async_wait_8h_source.html">delegate/DelegateAsyncWait.h</a>&quot;</code><br />
110110
<code>#include &quot;<a class="el" href="_delegate_remote_8h_source.html">delegate/DelegateRemote.h</a>&quot;</code><br />

docs/html/_delegate_m_q_8h_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
110110
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#include &quot;<a class="code" href="_delegate_opt_8h.html">delegate/DelegateOpt.h</a>&quot;</span></div>
111111
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#include &quot;<a class="code" href="_multicast_delegate_safe_8h.html">delegate/MulticastDelegateSafe.h</a>&quot;</span></div>
112-
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#include &quot;<a class="code" href="_unicast_delegate_8h.html">delegate/UnicastDelegate.h</a>&quot;</span></div>
112+
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#include &quot;<a class="code" href="_unicast_delegate_safe_8h.html">delegate/UnicastDelegateSafe.h</a>&quot;</span></div>
113113
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#include &quot;<a class="code" href="_delegate_async_8h.html">delegate/DelegateAsync.h</a>&quot;</span></div>
114114
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#include &quot;<a class="code" href="_delegate_async_wait_8h.html">delegate/DelegateAsyncWait.h</a>&quot;</span></div>
115115
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor">#include &quot;<a class="code" href="_delegate_remote_8h.html">delegate/DelegateRemote.h</a>&quot;</span></div>
@@ -173,7 +173,7 @@
173173
<div class="ttc" id="a_multicast_delegate_safe_8h_html"><div class="ttname"><a href="_multicast_delegate_safe_8h.html">MulticastDelegateSafe.h</a></div><div class="ttdoc">Delegate container for storing and iterating over a collection of delegate instances....</div></div>
174174
<div class="ttc" id="a_timer_8h_html"><div class="ttname"><a href="_timer_8h.html">Timer.h</a></div></div>
175175
<div class="ttc" id="a_transport_monitor_8h_html"><div class="ttname"><a href="_transport_monitor_8h.html">TransportMonitor.h</a></div></div>
176-
<div class="ttc" id="a_unicast_delegate_8h_html"><div class="ttname"><a href="_unicast_delegate_8h.html">UnicastDelegate.h</a></div><div class="ttdoc">Delegate container for storing an invoking a single delegate instance. Class is not thread-safe.</div></div>
176+
<div class="ttc" id="a_unicast_delegate_safe_8h_html"><div class="ttname"><a href="_unicast_delegate_safe_8h.html">UnicastDelegateSafe.h</a></div><div class="ttdoc">Delegate container for storing an invoking a single delegate instance. Class is not thread-safe.</div></div>
177177
<div class="ttc" id="a_win32_pipe_transport_8h_html"><div class="ttname"><a href="_win32_pipe_transport_8h.html">Win32PipeTransport.h</a></div></div>
178178
<div class="ttc" id="a_win32_udp_transport_8h_html"><div class="ttname"><a href="_win32_udp_transport_8h.html">Win32UdpTransport.h</a></div></div>
179179
<div class="ttc" id="a_zero_mq_transport_8h_html"><div class="ttname"><a href="_zero_mq_transport_8h.html">ZeroMqTransport.h</a></div></div>

docs/html/_multicast_delegate_safe_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@
185185
<div class="foldopen" id="foldopen00092" data-start="{" data-end="}">
186186
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classdmq_1_1_multicast_delegate_safe_3_01_ret_type_07_args_8_8_8_08_4.html#a31c7a2d64528e2d60e3abc159e5c11e2"> 92</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdmq_1_1_multicast_delegate_safe_3_01_ret_type_07_args_8_8_8_08_4.html#a31c7a2d64528e2d60e3abc159e5c11e2">operator=</a>(std::nullptr_t) <span class="keyword">noexcept</span> { </div>
187187
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">const</span> std::lock_guard&lt;std::mutex&gt; lock(m_lock);</div>
188-
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">return</span> BaseType::Clear(); </div>
188+
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> BaseType::Clear(); </div>
189189
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> }</div>
190190
</div>
191191
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>

docs/html/_timer_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
<div class="headertitle"><div class="title">Timer.h File Reference</div></div>
102102
</div><!--header-->
103103
<div class="contents">
104-
<div class="textblock"><code>#include &quot;<a class="el" href="_unicast_delegate_8h_source.html">../../delegate/UnicastDelegate.h</a>&quot;</code><br />
104+
<div class="textblock"><code>#include &quot;<a class="el" href="_unicast_delegate_safe_8h_source.html">../../delegate/UnicastDelegateSafe.h</a>&quot;</code><br />
105105
<code>#include &lt;mutex&gt;</code><br />
106106
<code>#include &lt;list&gt;</code><br />
107107
</div>

0 commit comments

Comments
 (0)