Skip to content

Commit

Permalink
[automated site update]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Sep 23, 2024
1 parent 7c55038 commit 93edff6
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 22 deletions.
12 changes: 6 additions & 6 deletions apidoc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ <h2><a class="anchor" id="autotoc_md3"></a>
<li><a class="el" href="index.html#sharing-and-pulling">Sharing and pulling data</a></li>
<li><a class="el" href="index.html#lazy-pulling">Lazy pulling (high-frequency queries)</a></li>
<li><a class="el" href="index.html#pipelined-pulls">Pipelined pulls (high volume queries)</a></li>
<li><a class="el" href="index.html#notifications">Custom notification and update handling</a></li>
<li><a class="el" href="index.html#update-handling">Custom update handling</a></li>
<li><a class="el" href="index.html#status-messages">Program status / error messages via SMA-X</a></li>
<li><a class="el" href="index.html#optional-metadata">Optional metadata</a></li>
<li><a class="el" href="index.html#error-handling">Error handling</a></li>
Expand Down Expand Up @@ -547,9 +547,9 @@ <h3><a class="anchor" id="autotoc_md32"></a>
<div class="line">}</div>
<div class="ttc" id="asmax-queue_8c_html_a065361085eed93188b7fd3ffe3a7eaf5"><div class="ttname"><a href="smax-queue_8c.html#a065361085eed93188b7fd3ffe3a7eaf5">smaxWaitQueueComplete</a></div><div class="ttdeci">int smaxWaitQueueComplete(int timeoutMillis)</div><div class="ttdef"><b>Definition</b> smax-queue.c:326</div></div>
</div><!-- fragment --><hr />
<p><a class="anchor" id="notifications"></a> </p>
<p><a class="anchor" id="update-handling"></a> </p>
<h2><a class="anchor" id="autotoc_md34"></a>
Custom notifications and update handling</h2>
Custom update handling</h2>
<ul>
<li><a class="el" href="index.html#monitoring-updates">Monitoring updates</a></li>
<li><a class="el" href="index.html#waiting-for-updates">Waiting for updates</a></li>
Expand Down Expand Up @@ -647,8 +647,8 @@ <h3><a class="anchor" id="autotoc_md40"></a>
<div class="line"> </div>
<div class="line"><span class="comment">// Broadcast a warning message for &quot;my_program_id&quot;</span></div>
<div class="line">int status = <a class="code hl_function" href="smax-messages_8c.html#a1c90a439b48a53555e9cfb60ce1b9102">smaxSendWarning</a>(<span class="stringliteral">&quot;Something did not work&quot;</span> %s<span class="stringliteral">&quot;, explanation);</span></div>
<div class="ttc" id="asmax-messages_8c_html_a1c90a439b48a53555e9cfb60ce1b9102"><div class="ttname"><a href="smax-messages_8c.html#a1c90a439b48a53555e9cfb60ce1b9102">smaxSendWarning</a></div><div class="ttdeci">int smaxSendWarning(const char *msg,...)</div><div class="ttdef"><b>Definition</b> smax-messages.c:207</div></div>
<div class="ttc" id="asmax-messages_8c_html_af3e8295bb941f68cf3177c79cd5fb4d3"><div class="ttname"><a href="smax-messages_8c.html#af3e8295bb941f68cf3177c79cd5fb4d3">smaxSetMessageSenderID</a></div><div class="ttdeci">void smaxSetMessageSenderID(const char *id)</div><div class="ttdef"><b>Definition</b> smax-messages.c:106</div></div>
<div class="ttc" id="asmax-messages_8c_html_a1c90a439b48a53555e9cfb60ce1b9102"><div class="ttname"><a href="smax-messages_8c.html#a1c90a439b48a53555e9cfb60ce1b9102">smaxSendWarning</a></div><div class="ttdeci">int smaxSendWarning(const char *msg,...)</div><div class="ttdef"><b>Definition</b> smax-messages.c:213</div></div>
<div class="ttc" id="asmax-messages_8c_html_af3e8295bb941f68cf3177c79cd5fb4d3"><div class="ttname"><a href="smax-messages_8c.html#af3e8295bb941f68cf3177c79cd5fb4d3">smaxSetMessageSenderID</a></div><div class="ttdeci">void smaxSetMessageSenderID(const char *id)</div><div class="ttdef"><b>Definition</b> smax-messages.c:112</div></div>
</div><!-- fragment --><p><a class="anchor" id="processing-messages"></a> </p>
<h3><a class="anchor" id="autotoc_md41"></a>
Processing program messages</h3>
Expand Down Expand Up @@ -677,7 +677,7 @@ <h3><a class="anchor" id="autotoc_md41"></a>
<div class="line"> <span class="comment">// Oops that did not work as planned.</span></div>
<div class="line"> ...</div>
<div class="line">}</div>
<div class="ttc" id="asmax-messages_8c_html_abaa2573fb8e85e8359c8853647c38f2f"><div class="ttname"><a href="smax-messages_8c.html#abaa2573fb8e85e8359c8853647c38f2f">smaxAddMessageProcessor</a></div><div class="ttdeci">int smaxAddMessageProcessor(const char *host, const char *prog, const char *type, void(*f)(XMessage *))</div><div class="ttdef"><b>Definition</b> smax-messages.c:291</div></div>
<div class="ttc" id="asmax-messages_8c_html_abaa2573fb8e85e8359c8853647c38f2f"><div class="ttname"><a href="smax-messages_8c.html#abaa2573fb8e85e8359c8853647c38f2f">smaxAddMessageProcessor</a></div><div class="ttdeci">int smaxAddMessageProcessor(const char *host, const char *prog, const char *type, void(*f)(XMessage *))</div><div class="ttdef"><b>Definition</b> smax-messages.c:297</div></div>
</div><!-- fragment --><p>Each string argument (<code>host</code>, <code>prog</code>, and <code>type</code>) may take an asterisk (<code>"*"</code>) or <code>NULL</code> as the argument to indicate that the processor function should be called for incoming messages for all values for the given parameter.</p>
<p>The processor function can also inspect what type of message it received by comparing the <code><a class="el" href="structXMessage.html" title="SMA-X program message.">XMessage</a></code> <code>type</code> value against one of the pre-defined constant expressions in <code><a class="el" href="smax_8h.html">smax.h</a></code>:</p>
<table class="markdownTable">
Expand Down
2 changes: 1 addition & 1 deletion apidoc/html/navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ var NAVTREE =
[ "Callbacks", "index.html#autotoc_md31", null ],
[ "Finishing up", "index.html#autotoc_md32", null ]
] ],
[ "Custom notifications and update handling", "index.html#autotoc_md34", [
[ "Custom update handling", "index.html#autotoc_md34", [
[ "Monitoring updates", "index.html#autotoc_md35", null ],
[ "Waiting for updates", "index.html#autotoc_md36", null ],
[ "Update callbacks", "index.html#autotoc_md37", null ]
Expand Down
9 changes: 4 additions & 5 deletions apidoc/html/search/all_1.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ var searchData=
['an_20application_0',['Broadcasting status messages from an application',['../index.html#autotoc_md40',1,'']]],
['and_20pulling_20data_1',['Sharing and pulling data',['../index.html#autotoc_md19',1,'']]],
['and_20sizes_2',['Flexible types and sizes',['../index.html#autotoc_md22',1,'']]],
['and_20update_20handling_3',['Custom notifications and update handling',['../index.html#autotoc_md34',1,'']]],
['and_20waiting_4',['Synchronization points and waiting',['../index.html#autotoc_md30',1,'']]],
['application_5',['Broadcasting status messages from an application',['../index.html#autotoc_md40',1,'']]],
['arrays_6',['Arrays',['../index.html#autotoc_md24',1,'']]],
['axis_7',['axis',['../structXCoordinateSystem.html#a5275f744c5bfc9a13b31a19c7ec5346c',1,'XCoordinateSystem']]]
['and_20waiting_3',['Synchronization points and waiting',['../index.html#autotoc_md30',1,'']]],
['application_4',['Broadcasting status messages from an application',['../index.html#autotoc_md40',1,'']]],
['arrays_5',['Arrays',['../index.html#autotoc_md24',1,'']]],
['axis_6',['axis',['../structXCoordinateSystem.html#a5275f744c5bfc9a13b31a19c7ec5346c',1,'XCoordinateSystem']]]
];
2 changes: 1 addition & 1 deletion apidoc/html/search/all_14.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ var searchData=
['unreleased_2',['[Unreleased]',['../md_CHANGELOG.html#autotoc_md1',1,'']]],
['up_3',['Finishing up',['../index.html#autotoc_md32',1,'']]],
['update_20callbacks_4',['Update callbacks',['../index.html#autotoc_md37',1,'']]],
['update_20handling_5',['Custom notifications and update handling',['../index.html#autotoc_md34',1,'']]],
['update_20handling_5',['Custom update handling',['../index.html#autotoc_md34',1,'']]],
['updates_6',['updates',['../index.html#autotoc_md35',1,'Monitoring updates'],['../index.html#autotoc_md36',1,'Waiting for updates']]]
];
2 changes: 1 addition & 1 deletion apidoc/html/search/all_3.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ var searchData=
['contents_8',['Table of Contents',['../index.html#autotoc_md3',1,'']]],
['contributing_20to_20smax_20clib_9',['Contributing to smax-clib',['../../../redisx/apidoc/html/md_CONTRIBUTING.html',1,'']]],
['coordinate_20systems_10',['Coordinate Systems',['../index.html#autotoc_md45',1,'']]],
['custom_20notifications_20and_20update_20handling_11',['Custom notifications and update handling',['../index.html#autotoc_md34',1,'']]]
['custom_20update_20handling_11',['Custom update handling',['../index.html#autotoc_md34',1,'']]]
];
2 changes: 1 addition & 1 deletion apidoc/html/search/all_8.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var searchData=
[
['handling_0',['handling',['../index.html#autotoc_md34',1,'Custom notifications and update handling'],['../index.html#autotoc_md48',1,'Error handling']]],
['handling_0',['handling',['../index.html#autotoc_md34',1,'Custom update handling'],['../index.html#autotoc_md48',1,'Error handling']]],
['hget_5fwith_5fmeta_1',['HGET_WITH_META',['../smax_8c.html#ac5e36a13b5d67f497b15ab44b5a315af',1,'smax.c']]],
['high_20frequency_20queries_2',['Lazy pulling (high-frequency queries)',['../index.html#autotoc_md27',1,'']]],
['high_20volume_20queries_3',['Pipelined pulling (high volume queries)',['../index.html#autotoc_md29',1,'']]],
Expand Down
3 changes: 1 addition & 2 deletions apidoc/html/search/all_d.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ var searchData=
['name_1',['name',['../../../xchange/apidoc/html/structXField.html#a5ac083a645d964373f022d03df4849c8',1,'XField::name'],['../structXCoordinateAxis.html#a5ac083a645d964373f022d03df4849c8',1,'XCoordinateAxis::name']]],
['naxis_2',['nAxis',['../structXCoordinateSystem.html#a66b674e84aa11d53a5f0763237b764ba',1,'XCoordinateSystem']]],
['ndim_3',['ndim',['../../../xchange/apidoc/html/structXField.html#a0d9c8cbc461c7cf86cad8e548f195bd1',1,'XField']]],
['next_4',['next',['../../../xchange/apidoc/html/structXField.html#ae1ebaf87eb62e6266b14908eee28e565',1,'XField']]],
['notifications_20and_20update_20handling_5',['Custom notifications and update handling',['../index.html#autotoc_md34',1,'']]]
['next_4',['next',['../../../xchange/apidoc/html/structXField.html#ae1ebaf87eb62e6266b14908eee28e565',1,'XField']]]
];
2 changes: 1 addition & 1 deletion apidoc/html/toc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<topic label="Callbacks" href="index.html#autotoc_md31"/>
<topic label="Finishing up" href="index.html#autotoc_md32"/>
</topic>
<topic label="Custom notifications and update handling" href="index.html#autotoc_md34">
<topic label="Custom update handling" href="index.html#autotoc_md34">
<topic label="Monitoring updates" href="index.html#autotoc_md35"/>
<topic label="Waiting for updates" href="index.html#autotoc_md36"/>
<topic label="Update callbacks" href="index.html#autotoc_md37"/>
Expand Down
2 changes: 1 addition & 1 deletion apidoc/smax.tag
Original file line number Diff line number Diff line change
Expand Up @@ -2614,7 +2614,7 @@
<docanchor file="index.html">lazy-synchronization</docanchor>
<docanchor file="index.html">lazy-callbacks</docanchor>
<docanchor file="index.html">lazy-finish</docanchor>
<docanchor file="index.html">notifications</docanchor>
<docanchor file="index.html">update-handling</docanchor>
<docanchor file="index.html">monitoring-updates</docanchor>
<docanchor file="index.html">waiting-for-updates</docanchor>
<docanchor file="index.html">update-callbacks</docanchor>
Expand Down
6 changes: 3 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Last Updated: 18 September 2024
- [Sharing and pulling data](#sharing-and-pulling)
- [Lazy pulling (high-frequency queries)](#lazy-pulling)
- [Pipelined pulls (high volume queries)](#pipelined-pulls)
- [Custom notification and update handling](#notifications)
- [Custom update handling](#update-handling)
- [Program status / error messages via SMA-X](#status-messages)
- [Optional metadata](#optional-metadata)
- [Error handling](#error-handling)
Expand Down Expand Up @@ -674,8 +674,8 @@ all previously sumbitted requests have been collected. You can do that with:

------------------------------------------------------------------------------

<a name="notifications"></a>
## Custom notifications and update handling
<a name="update-handling"></a>
## Custom update handling

- [Monitoring updates](#monitoring-updates)
- [Waiting for updates](#waiting-for-updates)
Expand Down

0 comments on commit 93edff6

Please sign in to comment.