SharedQueue.st
changeset 30 f34b335ac2d7
parent 14 ca0b5fbc8131
child 34 8913d4dad799
--- a/SharedQueue.st	Thu Jun 02 18:20:07 1994 +0200
+++ b/SharedQueue.st	Thu Jun 02 18:22:02 1994 +0200
@@ -17,13 +17,48 @@
          category:'Collections-Ordered'!
 
 SharedQueue comment:'
-SharedQueues provide a safe mechanism for processes to communicate.
+COPYRIGHT (c) 1993 by Claus Gittinger
+              All Rights Reserved
+'!
+
+!SharedQueue class methodsFor:'documentation'!
 
-See samples in doc/coding.
+copyright
+"
+ COPYRIGHT (c) 1993 by Claus Gittinger
+              All Rights Reserved
+
+ This software is furnished under a license and may be used
+ only in accordance with the terms of that license and with the
+ inclusion of the above copyright notice.   This software may not
+ be provided or otherwise made available to, or used by, any
+ other person.  No title to or ownership of the software is
+ hereby transferred.
+"
+!
 
-$Header: /cvs/stx/stx/libbasic2/SharedQueue.st,v 1.5 1994-01-09 21:24:30 claus Exp $
+version
+"
+$Header: /cvs/stx/stx/libbasic2/SharedQueue.st,v 1.6 1994-06-02 16:22:02 claus Exp $
+"
+!
 
-'!
+documentation
+"
+    SharedQueues provide a safe mechanism for processes to communicate.
+    They are basically Queues, with added secure access to the internals,
+    allowing use from multiple processes (i.e. the access methods use
+    critical regions to protect against confusion due to a process
+    switch within a modification).
+
+    Also, sharedQueues can be used for synchronization, since a reading
+    process will be blocked when attempting to read an empty queue, while
+    a writer will be blocked when attempting to write into a full queue.
+    For nonBlocking read, use #isEmpty; for nonBlocking write, use #isFull.
+
+    See samples in doc/coding.
+"
+! !
 
 !SharedQueue methodsFor:'initialization'!