diff options
| author | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2016-03-17 08:20:29 +0000 |
|---|---|---|
| committer | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2016-03-17 08:20:29 +0000 |
| commit | fe9817618d0d3b382e440e6fbd08540b53354986 (patch) | |
| tree | de2b368ae88151f8477e0192b9c7a7f83e74a45c | |
| parent | a5456a1d8308cec5461846418500f77b69a01e4d (diff) | |
| download | ruby-fe9817618d0d3b382e440e6fbd08540b53354986.tar.gz | |
thread_sync.c: Update rdoc for Queue [skip ci]
* thread_sync.c: [DOC] Update documentation for Queue class
description. [Fix GH-1292]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@54146 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | thread_sync.c | 8 |
2 files changed, 12 insertions, 1 deletions
@@ -1,3 +1,8 @@ +Thu Mar 17 17:20:28 2016 Anton Davydov <antondavydov.o@gmail.com> + + * thread_sync.c: [DOC] Update documentation for Queue class + description. [Fix GH-1292] + Thu Mar 17 17:14:51 2016 Dinar Valeev <dvaleev@suse.com> * gc.c (tick): Use __builtin_ppc_get_timebase for POWER arch. diff --git a/thread_sync.c b/thread_sync.c index 9ac28a9aa0..9de9c32965 100644 --- a/thread_sync.c +++ b/thread_sync.c @@ -632,7 +632,13 @@ queue_do_close(VALUE self, int is_szq) /* * Document-class: Queue * - * This class provides a way to synchronize communication between threads. + * The Queue class implements multi-producer, multi-consumer queues. + * It is especially useful in threaded programming when information + * must be exchanged safely between multiple threads. The Queue class + * implements all the required locking semantics. + * + * The class implements FIFO type of queue. In a FIFO queue, the first + * tasks added are the first retrieved. * * Example: * |