[skip ci] Update docs: 8505264: [ADDED] Support %-encoded username/pa…

…ssword in server URLs (#765)
nats-io · Jun 13, 2024 · cf067b0 · cf067b0
1 parent 8505264
commit cf067b0
Show file tree

Hide file tree

Showing 84 changed files with 2,598 additions and 2,551 deletions.
diff --git a/doc/html/globals_func_n.html b/doc/html/globals_func_n.html
@@ -236,6 +236,9 @@ <h3><a id="index_n"></a>- n -</h3><ul>
 <li>natsConnection_QueueSubscribeTimeout()
 : <a class="el" href="group__conn_sub_group.html#ga96fa115fd5b2ef7658884da80714b91c">nats.h</a>
 </li>
+<li>natsConnection_Reconnect()
+: <a class="el" href="group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e">nats.h</a>
+</li>
 <li>natsConnection_Request()
 : <a class="el" href="group__conn_pub_group.html#gaf4b4a022f9c21fc269b87c000330c5a7">nats.h</a>
 </li>

diff --git a/doc/html/globals_n.html b/doc/html/globals_n.html
@@ -377,6 +377,9 @@ <h3><a id="index_n"></a>- n -</h3><ul>
 <li>natsConnection_QueueSubscribeTimeout()
 : <a class="el" href="group__conn_sub_group.html#ga96fa115fd5b2ef7658884da80714b91c">nats.h</a>
 </li>
+<li>natsConnection_Reconnect()
+: <a class="el" href="group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e">nats.h</a>
+</li>
 <li>natsConnection_Request()
 : <a class="el" href="group__conn_pub_group.html#gaf4b4a022f9c21fc269b87c000330c5a7">nats.h</a>
 </li>

diff --git a/doc/html/group__conn_mgt_group.html b/doc/html/group__conn_mgt_group.html
@@ -95,6 +95,9 @@
 <tr class="memitem:ga740be1ba16a8570eb98ef6755ebf52ce"><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__conn_mgt_group.html#ga740be1ba16a8570eb98ef6755ebf52ce">natsConnection_Connect</a> (<a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec">natsConnection</a> **nc, <a class="el" href="group__types_group.html#gabcc48b40a81fe302188f4ee06ea9c54e">natsOptions</a> *options)</td></tr>
 <tr class="memdesc:ga740be1ba16a8570eb98ef6755ebf52ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to a <code>NATS Server</code> using the provided options.  <a href="group__conn_mgt_group.html#ga740be1ba16a8570eb98ef6755ebf52ce">More...</a><br /></td></tr>
 <tr class="separator:ga740be1ba16a8570eb98ef6755ebf52ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gab189a6974024f58944cdaa5612d4587e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e">natsConnection_Reconnect</a> (<a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec">natsConnection</a> *nc)</td></tr>
+<tr class="memdesc:gab189a6974024f58944cdaa5612d4587e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Causes the client to drop the connection to the current server and perform standard reconnection process.  <a href="group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e">More...</a><br /></td></tr>
+<tr class="separator:gab189a6974024f58944cdaa5612d4587e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gaa89c06e30e19ff361125bfc9114d89a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conn_mgt_group.html#gaa89c06e30e19ff361125bfc9114d89a8">natsConnection_ProcessReadEvent</a> (<a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec">natsConnection</a> *nc)</td></tr>
 <tr class="memdesc:gaa89c06e30e19ff361125bfc9114d89a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a read event when using external event loop.  <a href="group__conn_mgt_group.html#gaa89c06e30e19ff361125bfc9114d89a8">More...</a><br /></td></tr>
 <tr class="separator:gaa89c06e30e19ff361125bfc9114d89a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -218,6 +221,31 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga740be1ba16a8570eb98ef67
   </dd>
 </dl>
 
+</div>
+</div>
+<a id="gab189a6974024f58944cdaa5612d4587e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gab189a6974024f58944cdaa5612d4587e">&#9670;&nbsp;</a></span>natsConnection_Reconnect()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> natsConnection_Reconnect </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec">natsConnection</a> *&#160;</td>
+          <td class="paramname"><em>nc</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>This means that all subscriptions and consumers should be resubscribed and their work resumed after successful reconnect where all reconnect options are respected.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">nc</td><td>the pointer to the <a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec" title="A connection to a NATS Server.">natsConnection</a> object. </td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 <a id="gaa89c06e30e19ff361125bfc9114d89a8"></a>

diff --git a/doc/html/group__conn_mgt_group.js b/doc/html/group__conn_mgt_group.js
@@ -1,6 +1,7 @@
 var group__conn_mgt_group =
 [
     [ "natsConnection_Connect", "group__conn_mgt_group.html#ga740be1ba16a8570eb98ef6755ebf52ce", null ],
+    [ "natsConnection_Reconnect", "group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e", null ],
     [ "natsConnection_ProcessReadEvent", "group__conn_mgt_group.html#gaa89c06e30e19ff361125bfc9114d89a8", null ],
     [ "natsConnection_ProcessWriteEvent", "group__conn_mgt_group.html#gad81b603b84c0180aefc6d5ebad7f2a47", null ],
     [ "natsConnection_ConnectTo", "group__conn_mgt_group.html#gafb83c8d7970ba68be0e6c40c38cdfde4", null ],

diff --git a/doc/html/nats_8h.html b/doc/html/nats_8h.html
@@ -931,6 +931,9 @@
 <tr class="memitem:ga740be1ba16a8570eb98ef6755ebf52ce"><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__conn_mgt_group.html#ga740be1ba16a8570eb98ef6755ebf52ce">natsConnection_Connect</a> (<a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec">natsConnection</a> **nc, <a class="el" href="group__types_group.html#gabcc48b40a81fe302188f4ee06ea9c54e">natsOptions</a> *options)</td></tr>
 <tr class="memdesc:ga740be1ba16a8570eb98ef6755ebf52ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to a <code>NATS Server</code> using the provided options.  <a href="group__conn_mgt_group.html#ga740be1ba16a8570eb98ef6755ebf52ce">More...</a><br /></td></tr>
 <tr class="separator:ga740be1ba16a8570eb98ef6755ebf52ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gab189a6974024f58944cdaa5612d4587e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e">natsConnection_Reconnect</a> (<a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec">natsConnection</a> *nc)</td></tr>
+<tr class="memdesc:gab189a6974024f58944cdaa5612d4587e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Causes the client to drop the connection to the current server and perform standard reconnection process.  <a href="group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e">More...</a><br /></td></tr>
+<tr class="separator:gab189a6974024f58944cdaa5612d4587e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gaa89c06e30e19ff361125bfc9114d89a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conn_mgt_group.html#gaa89c06e30e19ff361125bfc9114d89a8">natsConnection_ProcessReadEvent</a> (<a class="el" href="group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec">natsConnection</a> *nc)</td></tr>
 <tr class="memdesc:gaa89c06e30e19ff361125bfc9114d89a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a read event when using external event loop.  <a href="group__conn_mgt_group.html#gaa89c06e30e19ff361125bfc9114d89a8">More...</a><br /></td></tr>
 <tr class="separator:gaa89c06e30e19ff361125bfc9114d89a8"><td class="memSeparator" colspan="2">&#160;</td></tr>

diff --git a/doc/html/nats_8h.js b/doc/html/nats_8h.js
@@ -280,6 +280,7 @@ var nats_8h =
     [ "stanMsg_GetDataLength", "group__stan_msg_group.html#ga7d1e394a686bc25ab7376b7f28b9e777", null ],
     [ "stanMsg_Destroy", "group__stan_msg_group.html#gacd0059fb499963f5b2eae18053e5f74f", null ],
     [ "natsConnection_Connect", "group__conn_mgt_group.html#ga740be1ba16a8570eb98ef6755ebf52ce", null ],
+    [ "natsConnection_Reconnect", "group__conn_mgt_group.html#gab189a6974024f58944cdaa5612d4587e", null ],
     [ "natsConnection_ProcessReadEvent", "group__conn_mgt_group.html#gaa89c06e30e19ff361125bfc9114d89a8", null ],
     [ "natsConnection_ProcessWriteEvent", "group__conn_mgt_group.html#gad81b603b84c0180aefc6d5ebad7f2a47", null ],
     [ "natsConnection_ConnectTo", "group__conn_mgt_group.html#gafb83c8d7970ba68be0e6c40c38cdfde4", null ],