SharedQueue.st
author claus
Thu, 02 Jun 1994 18:22:02 +0200
changeset 30 f34b335ac2d7
parent 14 ca0b5fbc8131
child 34 8913d4dad799
permissions -rw-r--r--
*** empty log message ***
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     1
"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     2
 COPYRIGHT (c) 1993 by Claus Gittinger
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     3
              All Rights Reserved
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     4
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     5
 This software is furnished under a license and may be used
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    10
 hereby transferred.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    11
"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    12
6
claus
parents: 3
diff changeset
    13
Queue subclass:#SharedQueue
claus
parents: 3
diff changeset
    14
         instanceVariableNames:'accessProtect dataAvailable spaceAvailable'
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    15
         classVariableNames:''
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    16
         poolDictionaries:''
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    17
         category:'Collections-Ordered'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    18
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    19
SharedQueue comment:'
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    20
COPYRIGHT (c) 1993 by Claus Gittinger
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    21
              All Rights Reserved
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    22
'!
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    23
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    24
!SharedQueue class methodsFor:'documentation'!
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    25
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    26
copyright
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    27
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    28
 COPYRIGHT (c) 1993 by Claus Gittinger
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    29
              All Rights Reserved
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    31
 This software is furnished under a license and may be used
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    32
 only in accordance with the terms of that license and with the
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    33
 inclusion of the above copyright notice.   This software may not
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    34
 be provided or otherwise made available to, or used by, any
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    35
 other person.  No title to or ownership of the software is
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    36
 hereby transferred.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    37
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    38
!
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    39
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    40
version
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    41
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    42
$Header: /cvs/stx/stx/libbasic2/SharedQueue.st,v 1.6 1994-06-02 16:22:02 claus Exp $
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    43
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    44
!
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    45
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    46
documentation
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    47
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    48
    SharedQueues provide a safe mechanism for processes to communicate.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    49
    They are basically Queues, with added secure access to the internals,
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    50
    allowing use from multiple processes (i.e. the access methods use
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    51
    critical regions to protect against confusion due to a process
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    52
    switch within a modification).
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    53
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    54
    Also, sharedQueues can be used for synchronization, since a reading
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    55
    process will be blocked when attempting to read an empty queue, while
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    56
    a writer will be blocked when attempting to write into a full queue.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    57
    For nonBlocking read, use #isEmpty; for nonBlocking write, use #isFull.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    58
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    59
    See samples in doc/coding.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    60
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    61
! !
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    62
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    63
!SharedQueue methodsFor:'initialization'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    64
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    65
init:size
14
ca0b5fbc8131 *** empty log message ***
claus
parents: 6
diff changeset
    66
    "initialize the receiver for size entries"
ca0b5fbc8131 *** empty log message ***
claus
parents: 6
diff changeset
    67
6
claus
parents: 3
diff changeset
    68
    super init:size.
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    69
    accessProtect := Semaphore forMutualExclusion.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    70
    dataAvailable := Semaphore new.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    71
    spaceAvailable := Semaphore new
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    72
! !
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    73
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    74
!SharedQueue methodsFor:'accessing'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    75
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    76
next
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    77
    "return the next value in the queue; if it its empty, wait 'til
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    78
     something is put into the receiver.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    79
     When the datum has been removed, signal space-availability to
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    80
     writers"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    81
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    82
    |value ok|
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    83
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    84
    ok := false.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    85
    [ok] whileFalse:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    86
        [tally == 0] whileTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    87
            dataAvailable wait
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    88
        ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    89
        accessProtect critical:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    90
            "
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    91
             this check is needed, since another process may
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    92
             have read the value in the meantime ...
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    93
            "
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    94
            tally == 0 ifFalse:[
6
claus
parents: 3
diff changeset
    95
                value := super next.
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    96
                tally == (contentsArray size - 1) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    97
                    spaceAvailable signal
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    98
                ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    99
                ok := true
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   100
            ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   101
        ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   102
    ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   103
    ^ value
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   104
!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   105
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   106
nextPut:anObject
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   107
    "enter anObject into the queue; wait for available space, if
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   108
     the queue is full. After the put, signal availablity of a datum
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   109
     to readers."
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   110
1
claus
parents: 0
diff changeset
   111
    |ok|
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   112
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   113
    ok := false.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   114
    [ok] whileFalse:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   115
        [tally == contentsArray size] whileTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   116
            spaceAvailable wait
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   117
        ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   118
        accessProtect critical:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   119
            tally == contentsArray size ifFalse:[
6
claus
parents: 3
diff changeset
   120
                super nextPut:anObject.
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   121
                tally == 1 ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   122
                    dataAvailable signal
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   123
                ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   124
                ok := true
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   125
            ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   126
        ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   127
    ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   128
    ^ anObject
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   129
! !