-
Notifications
You must be signed in to change notification settings - Fork 418
/
Sliding.html
546 lines (297 loc) · 11.8 KB
/
Sliding.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Concurrent::Channel::Buffer::Sliding
— Concurrent Ruby
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "Concurrent::Channel::Buffer::Sliding";
relpath = '../../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (S)</a> »
<span class='title'><span class='object_link'><a href="../../../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span> » <span class='title'><span class='object_link'><a href="../../Channel.html" title="Concurrent::Channel (class)">Channel</a></span></span> » <span class='title'><span class='object_link'><a href="../Buffer.html" title="Concurrent::Channel::Buffer (module)">Buffer</a></span></span>
»
<span class="title">Sliding</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Concurrent::Channel::Buffer::Sliding
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Buffered.html" title="Concurrent::Channel::Buffer::Buffered (class)">Buffered</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'>Synchronization::LockableObject</span></li>
<li class="next"><span class='object_link'><a href="Base.html" title="Concurrent::Channel::Buffer::Base (class)">Base</a></span></li>
<li class="next"><span class='object_link'><a href="Buffered.html" title="Concurrent::Channel::Buffer::Buffered (class)">Buffered</a></span></li>
<li class="next">Concurrent::Channel::Buffer::Sliding</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib-edge/concurrent/channel/buffer/sliding.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A non-blocking, buffered buffer of fixed maximum capacity. When the
maximum capacity is reached subsequent <span class='object_link'><a href="#put-instance_method" title="Concurrent::Channel::Buffer::Sliding#put (method)">#put</a></span> and <span class='object_link'><a href="#offer-instance_method" title="Concurrent::Channel::Buffer::Sliding#offer (method)">#offer</a></span> operations
will complete and the item will be <code>put</code>, but the oldest elements in
the buffer will be discarded (not transferred).</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#blocking%3F-instance_method" title="#blocking? (instance method)">#<strong>blocking?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Predicate indicating if this buffer will block <span class='object_link'><a href="#put-instance_method" title="Concurrent::Channel::Buffer::Sliding#put (method)">#put</a></span> operations once it reaches its maximum capacity.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#full%3F-instance_method" title="#full? (instance method)">#<strong>full?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Predicate indicating if the buffer is full.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#offer-instance_method" title="#offer (instance method)">#<strong>offer</strong>(item) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Put an item onto the buffer if possible.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(item) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Put an item onto the buffer if possible.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Concurrent::Channel::Buffer::Base#initialize (method)">Concurrent::Channel::Buffer::Base</a></span></p>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="blocking?-instance_method">
#<strong>blocking?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Predicate indicating if this buffer will block <span class='object_link'><a href="#put-instance_method" title="Concurrent::Channel::Buffer::Sliding#put (method)">#put</a></span> operations
once it reaches its maximum capacity.</p>
<p>Always returns <code>false</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if this buffer blocks else false</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib-edge/concurrent/channel/buffer/sliding.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_blocking?'>blocking?</span>
<span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="full?-instance_method">
#<strong>full?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Predicate indicating if the buffer is full.</p>
<p>Always returns <code>false</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if this buffer is full else false</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib-edge/concurrent/channel/buffer/sliding.rb', line 27</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="offer-instance_method">
#<strong>offer</strong>(item) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Put an item onto the buffer if possible. If the buffer is open but
unable to add an item, probably due to being full, the method will
return immediately. Similarly, the method will return immediately
when the buffer is closed. A return value of <code>false</code> does not
necessarily indicate that the buffer is closed, just that the item
could not be added.</p>
<p>When the buffer is full, this method will return <code>true</code>
immediately and the item will be inserted, but the oldest
elements in the buffer will be discarded (not transferred).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>the item/value to put onto the buffer.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if the item was added to the buffer else
false (always false when closed).</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib-edge/concurrent/channel/buffer/sliding.rb', line 20</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="put-instance_method">
#<strong>put</strong>(item) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Put an item onto the buffer if possible. If the buffer is open
but not able to accept the item the calling thread will block
until the item can be put onto the buffer.</p>
<p>When the buffer is full, this method will return <code>true</code>
immediately and the item will be inserted, but the oldest
elements in the buffer will be discarded (not transferred).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>the item/value to put onto the buffer.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if the item was added to the buffer else
false (always false when closed).</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib-edge/concurrent/channel/buffer/sliding.rb', line 13</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_blank">yard</a>.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-57940973-1', 'auto');
ga('send', 'pageview');
</script>
</div>
</body>
</html>