Skip to content

Commit

Permalink
[skip ci] Update docs: 3f02b1d: [ADDED] kvStore_WatchMulti, js_Subscr…
Browse files Browse the repository at this point in the history
…ibe[Sync]Multi (#750)
  • Loading branch information
levb authored and github-actions[bot] committed May 1, 2024
1 parent 3f02b1d commit 22a7ee3
Show file tree
Hide file tree
Showing 92 changed files with 2,790 additions and 2,506 deletions.
6 changes: 6 additions & 0 deletions doc/html/globals.html
Expand Up @@ -230,9 +230,15 @@ <h3><a id="index_j"></a>- j -</h3><ul>
<li>js_Subscribe()
: <a class="el" href="group__js_sub_group.html#gaa686c6efd84ef963de1925108e896515">nats.h</a>
</li>
<li>js_SubscribeMulti()
: <a class="el" href="group__js_sub_group.html#gacb33da7a1644f8cad9d3c202a006bc91">nats.h</a>
</li>
<li>js_SubscribeSync()
: <a class="el" href="group__js_sub_group.html#gabacb010031e535f9fb6e2167337e8adf">nats.h</a>
</li>
<li>js_SubscribeSyncMulti()
: <a class="el" href="group__js_sub_group.html#ga87c1e984425049924c6d50597c3f579f">nats.h</a>
</li>
<li>js_UpdateConsumer()
: <a class="el" href="group__js_assets_group.html#gad13ec256e24710bb237995814871e554">nats.h</a>
</li>
Expand Down
6 changes: 6 additions & 0 deletions doc/html/globals_func.html
Expand Up @@ -173,9 +173,15 @@ <h3><a id="index_j"></a>- j -</h3><ul>
<li>js_Subscribe()
: <a class="el" href="group__js_sub_group.html#gaa686c6efd84ef963de1925108e896515">nats.h</a>
</li>
<li>js_SubscribeMulti()
: <a class="el" href="group__js_sub_group.html#gacb33da7a1644f8cad9d3c202a006bc91">nats.h</a>
</li>
<li>js_SubscribeSync()
: <a class="el" href="group__js_sub_group.html#gabacb010031e535f9fb6e2167337e8adf">nats.h</a>
</li>
<li>js_SubscribeSyncMulti()
: <a class="el" href="group__js_sub_group.html#ga87c1e984425049924c6d50597c3f579f">nats.h</a>
</li>
<li>js_UpdateConsumer()
: <a class="el" href="group__js_assets_group.html#gad13ec256e24710bb237995814871e554">nats.h</a>
</li>
Expand Down
3 changes: 3 additions & 0 deletions doc/html/globals_func_k.html
Expand Up @@ -203,6 +203,9 @@ <h3><a id="index_k"></a>- k -</h3><ul>
<li>kvStore_WatchAll()
: <a class="el" href="group__kv_group.html#gaf011f1dd6813391c65664e982747602e">nats.h</a>
</li>
<li>kvStore_WatchMulti()
: <a class="el" href="group__kv_group.html#ga409bfd787a87d0e37b69d3711fdb28f4">nats.h</a>
</li>
<li>kvWatcher_Destroy()
: <a class="el" href="group__kv_watcher.html#ga21bc39fa795f7c4f392bd6d4e66ea1d9">nats.h</a>
</li>
Expand Down
3 changes: 3 additions & 0 deletions doc/html/globals_k.html
Expand Up @@ -239,6 +239,9 @@ <h3><a id="index_k"></a>- k -</h3><ul>
<li>kvStore_WatchAll()
: <a class="el" href="group__kv_group.html#gaf011f1dd6813391c65664e982747602e">nats.h</a>
</li>
<li>kvStore_WatchMulti()
: <a class="el" href="group__kv_group.html#ga409bfd787a87d0e37b69d3711fdb28f4">nats.h</a>
</li>
<li>kvWatcher
: <a class="el" href="group__types_group.html#ga526fa6d37e818784b94cdc1713f3a043">nats.h</a>
</li>
Expand Down
163 changes: 162 additions & 1 deletion doc/html/group__js_sub_group.html

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions doc/html/group__js_sub_group.js
Expand Up @@ -2,7 +2,9 @@ var group__js_sub_group =
[
[ "jsSubOptions_Init", "group__js_sub_group.html#ga472adb949d1af9d8f07bda99f5d7f3f8", null ],
[ "js_Subscribe", "group__js_sub_group.html#gaa686c6efd84ef963de1925108e896515", null ],
[ "js_SubscribeMulti", "group__js_sub_group.html#gacb33da7a1644f8cad9d3c202a006bc91", null ],
[ "js_SubscribeSync", "group__js_sub_group.html#gabacb010031e535f9fb6e2167337e8adf", null ],
[ "js_SubscribeSyncMulti", "group__js_sub_group.html#ga87c1e984425049924c6d50597c3f579f", null ],
[ "js_PullSubscribe", "group__js_sub_group.html#gaaeaddb73857aa4eb4901eec945ed27cd", null ],
[ "natsSubscription_Fetch", "group__js_sub_group.html#gafc5e0d2269bd23b4d5fb7f3b05278e50", null ],
[ "jsFetchRequest_Init", "group__js_sub_group.html#ga1c3a62de8cd4855ae61ea4f67417a43b", null ],
Expand Down
63 changes: 63 additions & 0 deletions doc/html/group__kv_group.html
Expand Up @@ -146,6 +146,9 @@
<tr class="memitem:ga30feca870f580c7b9d2ad07a740505b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__kv_group.html#ga30feca870f580c7b9d2ad07a740505b2">kvStore_Watch</a> (<a class="el" href="group__types_group.html#ga526fa6d37e818784b94cdc1713f3a043">kvWatcher</a> **new_watcher, <a class="el" href="group__types_group.html#ga054c05493dd3cfc5c3e7a665a424e54a">kvStore</a> *kv, const char *keys, <a class="el" href="structkv_watch_options.html">kvWatchOptions</a> *opts)</td></tr>
<tr class="memdesc:ga30feca870f580c7b9d2ad07a740505b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a watcher for any updates to keys that match the <code>keys</code> argument. <a href="group__kv_group.html#ga30feca870f580c7b9d2ad07a740505b2">More...</a><br /></td></tr>
<tr class="separator:ga30feca870f580c7b9d2ad07a740505b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga409bfd787a87d0e37b69d3711fdb28f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__kv_group.html#ga409bfd787a87d0e37b69d3711fdb28f4">kvStore_WatchMulti</a> (<a class="el" href="group__types_group.html#ga526fa6d37e818784b94cdc1713f3a043">kvWatcher</a> **new_watcher, <a class="el" href="group__types_group.html#ga054c05493dd3cfc5c3e7a665a424e54a">kvStore</a> *kv, const char **keys, int numKeys, <a class="el" href="structkv_watch_options.html">kvWatchOptions</a> *opts)</td></tr>
<tr class="memdesc:ga409bfd787a87d0e37b69d3711fdb28f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a watcher for any updates to keys that match one of the <code>keys</code> argument. <a href="group__kv_group.html#ga409bfd787a87d0e37b69d3711fdb28f4">More...</a><br /></td></tr>
<tr class="separator:ga409bfd787a87d0e37b69d3711fdb28f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf011f1dd6813391c65664e982747602e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__kv_group.html#gaf011f1dd6813391c65664e982747602e">kvStore_WatchAll</a> (<a class="el" href="group__types_group.html#ga526fa6d37e818784b94cdc1713f3a043">kvWatcher</a> **new_watcher, <a class="el" href="group__types_group.html#ga054c05493dd3cfc5c3e7a665a424e54a">kvStore</a> *kv, <a class="el" href="structkv_watch_options.html">kvWatchOptions</a> *opts)</td></tr>
<tr class="memdesc:gaf011f1dd6813391c65664e982747602e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a watcher for any updates to any keys of the KeyValue store bucket. <a href="group__kv_group.html#gaf011f1dd6813391c65664e982747602e">More...</a><br /></td></tr>
<tr class="separator:gaf011f1dd6813391c65664e982747602e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -827,6 +830,66 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga30feca870f580c7b9d2ad07
</dd>
</dl>

</div>
</div>
<a id="ga409bfd787a87d0e37b69d3711fdb28f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga409bfd787a87d0e37b69d3711fdb28f4">&#9670;&nbsp;</a></span>kvStore_WatchMulti()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> kvStore_WatchMulti </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types_group.html#ga526fa6d37e818784b94cdc1713f3a043">kvWatcher</a> **&#160;</td>
<td class="paramname"><em>new_watcher</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types_group.html#ga054c05493dd3cfc5c3e7a665a424e54a">kvStore</a> *&#160;</td>
<td class="paramname"><em>kv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **&#160;</td>
<td class="paramname"><em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>numKeys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkv_watch_options.html">kvWatchOptions</a> *&#160;</td>
<td class="paramname"><em>opts</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a watcher for any updates to keys that match the one of <code>keys</code> argument, which could include wildcards.</p>
<p>A <code>NULL</code> entry will be posted when the watcher has received all initial values.</p>
<p>Call <a class="el" href="group__kv_watcher.html#ga562c216a0199c30455af4c2da46000e5" title="Returns the next entry for this watcher.">kvWatcher_Next</a> to get the next <a class="el" href="group__types_group.html#gad489fb4074f27427560ca71797db6191">kvEntry</a>.</p>
<dl class="section note"><dt>Note</dt><dd>The watcher should be destroyed to release memory using <a class="el" href="group__kv_watcher.html#ga21bc39fa795f7c4f392bd6d4e66ea1d9" title="Destroys the KeyValue watcher object.">kvWatcher_Destroy</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">new_watcher</td><td>the location where to store the pointer to the new <a class="el" href="group__types_group.html#ga526fa6d37e818784b94cdc1713f3a043">kvWatcher</a> object. </td></tr>
<tr><td class="paramname">kv</td><td>the pointer to the <a class="el" href="group__types_group.html#ga054c05493dd3cfc5c3e7a665a424e54a">kvStore</a> object. </td></tr>
<tr><td class="paramname">keys</td><td>the keys (wildcard possible) to create the watcher for. </td></tr>
<tr><td class="paramname">numKeys</td><td>the number of keys in the <code>keys</code> array. </td></tr>
<tr><td class="paramname">opts</td><td>the watcher options, possibly <code>NULL</code>. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="gaf011f1dd6813391c65664e982747602e"></a>
Expand Down
1 change: 1 addition & 0 deletions doc/html/group__kv_group.js
Expand Up @@ -18,6 +18,7 @@ var group__kv_group =
[ "kvPurgeOptions_Init", "group__kv_group.html#ga243113fd7df34ce104850ab888f04021", null ],
[ "kvStore_PurgeDeletes", "group__kv_group.html#ga34ab74b229ff88e64301ea53a274da69", null ],
[ "kvStore_Watch", "group__kv_group.html#ga30feca870f580c7b9d2ad07a740505b2", null ],
[ "kvStore_WatchMulti", "group__kv_group.html#ga409bfd787a87d0e37b69d3711fdb28f4", null ],
[ "kvStore_WatchAll", "group__kv_group.html#gaf011f1dd6813391c65664e982747602e", null ],
[ "kvStore_Keys", "group__kv_group.html#ga6030fc2a672ae868f7603587245b9d5a", null ],
[ "kvKeysList_Destroy", "group__kv_group.html#ga02ccd58bc5062f6ce6f94bf05e3dfe45", null ],
Expand Down

0 comments on commit 22a7ee3

Please sign in to comment.