Skip to content

Commit a771a1f

Browse files
thibaultchathibaultcha
committed
docs(*) generate 1.5.0 docs
1 parent b1e1271 commit a771a1f

16 files changed

+38
-20
lines changed

‎docs/examples/authentication.lua.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ <h2>authentication.lua</h2>
108108
</div> <!-- id="main" -->
109109
<div id="about">
110110
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
111-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
111+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
112112
</div> <!-- id="about" -->
113113
</div> <!-- id="container" -->
114114
</body>

‎docs/examples/batch.lua.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h2>batch.lua</h2>
142142
</div> <!-- id="main" -->
143143
<div id="about">
144144
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
145-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
145+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
146146
</div> <!-- id="about" -->
147147
</div> <!-- id="container" -->
148148
</body>

‎docs/examples/intro.lua.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ <h2>intro.lua</h2>
187187
</div> <!-- id="main" -->
188188
<div id="about">
189189
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
190-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
190+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
191191
</div> <!-- id="about" -->
192192
</div> <!-- id="container" -->
193193
</body>

‎docs/examples/pagination.lua.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h2>pagination.lua</h2>
118118
</div> <!-- id="main" -->
119119
<div id="about">
120120
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
121-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
121+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
122122
</div> <!-- id="about" -->
123123
</div> <!-- id="container" -->
124124
</body>

‎docs/examples/ssl.lua.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ <h2>ssl.lua</h2>
124124
</div> <!-- id="main" -->
125125
<div id="about">
126126
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
127-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
127+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
128128
</div> <!-- id="about" -->
129129
</div> <!-- id="container" -->
130130
</body>

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h2>Examples</h2>
135135
</div> <!-- id="main" -->
136136
<div id="about">
137137
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
138-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
138+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
139139
</div> <!-- id="about" -->
140140
</div> <!-- id="container" -->
141141
</body>

‎docs/manual/README.md.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ <h2>License</h2>
256256
</div> <!-- id="main" -->
257257
<div id="about">
258258
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
259-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
259+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
260260
</div> <!-- id="about" -->
261261
</div> <!-- id="container" -->
262262
</body>

‎docs/modules/cassandra.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ <h1>Module <code>cassandra</code></h1>
7171
<p> Single host module for PUC Lua, LuaJIT and OpenResty.</p>
7272
<h3>Info:</h3>
7373
<ul>
74-
<li><strong>Release</strong>: 1.4.0</li>
74+
<li><strong>Release</strong>: 1.5.0</li>
7575
<li><strong>Author</strong>: thibaultcha</li>
7676
</ul>
7777

@@ -1123,7 +1123,7 @@ <h3>Usage:</h3>
11231123
</div> <!-- id="main" -->
11241124
<div id="about">
11251125
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
1126-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
1126+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
11271127
</div> <!-- id="about" -->
11281128
</div> <!-- id="container" -->
11291129
</body>

‎docs/modules/resty.cassandra.cluster.html‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ <h1>Module <code>resty.cassandra.cluster</code></h1>
7171
<p> Cluster module for OpenResty.</p>
7272
<h3>Info:</h3>
7373
<ul>
74-
<li><strong>Release</strong>: 1.4.0</li>
74+
<li><strong>Release</strong>: 1.5.0</li>
7575
<li><strong>Author</strong>: thibaultcha</li>
7676
</ul>
7777

@@ -83,7 +83,7 @@ <h2><a href="#Functions">Functions</a></h2>
8383
<td class="summary">Create a new Cluster client.</td>
8484
</tr>
8585
<tr>
86-
<td class="name" nowrap><a href="#_Cluster:refresh">_Cluster:refresh ()</a></td>
86+
<td class="name" nowrap><a href="#_Cluster:refresh">_Cluster:refresh (timeout)</a></td>
8787
<td class="summary">Refresh the list of nodes in the cluster.</td>
8888
</tr>
8989
<tr>
@@ -168,17 +168,31 @@ <h3>Usage:</h3>
168168
</dd>
169169
<dt>
170170
<a name = "_Cluster:refresh"></a>
171-
<strong>_Cluster:refresh ()</strong>
171+
<strong>_Cluster:refresh (timeout)</strong>
172172
</dt>
173173
<dd>
174174
Refresh the list of nodes in the cluster.
175175
Queries one of the specified <code>contact_points</code> to retrieve the list of
176176
available nodes in the cluster, and update the configured policies.
177+
The query will use the timeout threshold specified in the <code>read_timeout</code>
178+
option of the <a href="../modules/resty.cassandra.cluster.html#_Cluster.new">new</a> method.
179+
This method is safe be called at runtime, by multiple workers at the same
180+
time, which can be useful to refresh the cluster topology when nodes are
181+
added or removed from the cluster.
177182
This method is automatically called upon the first query made to the
178183
cluster (from <a href="../modules/resty.cassandra.cluster.html#_Cluster:execute">execute</a>, <a href="../modules/resty.cassandra.cluster.html#_Cluster:batch">batch</a> or <a href="../modules/resty.cassandra.cluster.html#_Cluster:iterate">iterate</a>), but needs to be manually
179184
called if further updates are required.
180185

181186

187+
<h3>Parameters:</h3>
188+
<ul>
189+
<li><span class="parameter">timeout</span>
190+
<span class="types"><span class="type">number</span></span>
191+
Timeout threshold (in seconds) for a given
192+
worker when another worker is already refreshing the topology (defaults to
193+
the <code>lock_timeout</code> option of the <a href="../modules/resty.cassandra.cluster.html#_Cluster.new">new</a> method).
194+
</li>
195+
</ul>
182196

183197
<h3>Returns:</h3>
184198
<ol>
@@ -188,6 +202,10 @@ <h3>Returns:</h3>
188202
<li>
189203
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
190204
<code>err</code>: String describing the error if failure.</li>
205+
<li>
206+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
207+
<code>topology</code>: A table containing the topology changes if any.
208+
This value will only be returned when the worker acquired the lock.</li>
191209
</ol>
192210

193211

@@ -510,7 +528,7 @@ <h3>Fields:</h3>
510528
</div> <!-- id="main" -->
511529
<div id="about">
512530
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
513-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
531+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
514532
</div> <!-- id="about" -->
515533
</div> <!-- id="container" -->
516534
</body>

‎docs/modules/resty.cassandra.policies.lb.dc_rr.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h3>Usage:</h3>
137137
</div> <!-- id="main" -->
138138
<div id="about">
139139
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
140-
<i style="float:right;">Last updated 2019-06-21 15:26:50 </i>
140+
<i style="float:right;">Last updated 2019-09-25 17:56:05 </i>
141141
</div> <!-- id="about" -->
142142
</div> <!-- id="container" -->
143143
</body>

0 commit comments

Comments
 (0)