TimedPromise.st
author Claus Gittinger <cg@exept.de>
Tue, 25 Jun 2019 14:28:51 +0200
changeset 5050 44fa8672d102
parent 4631 992198b2f876
permissions -rw-r--r--
#DOCUMENTATION by cg class: SharedQueue comment/format in: #next #nextWithTimeout:
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1522
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     1
"
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     2
 COPYRIGHT (c) 2004 by eXept Software AG
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     3
              All Rights Reserved
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     4
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     5
 This software is furnished under a license and may be used
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     6
 only in accordance with the terms of that license and with the
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     8
 be provided or otherwise made available to, or used by, any
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
     9
 other person.  No title to or ownership of the software is
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    10
 hereby transferred.
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    11
"
1487
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    12
"{ Package: 'stx:libbasic2' }"
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    13
4631
992198b2f876 #BUGFIX by stefan
Stefan Vogel <sv@exept.de>
parents: 3187
diff changeset
    14
"{ NameSpace: Smalltalk }"
992198b2f876 #BUGFIX by stefan
Stefan Vogel <sv@exept.de>
parents: 3187
diff changeset
    15
1487
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    16
Promise subclass:#TimedPromise
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    17
	instanceVariableNames:'delay ms'
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    18
	classVariableNames:''
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    19
	poolDictionaries:''
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    20
	category:'Kernel-Processes'
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    21
!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    22
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    23
!TimedPromise class methodsFor:'documentation'!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    24
1522
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    25
copyright
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    26
"
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    27
 COPYRIGHT (c) 2004 by eXept Software AG
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    28
              All Rights Reserved
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    29
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    30
 This software is furnished under a license and may be used
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    31
 only in accordance with the terms of that license and with the
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    32
 inclusion of the above copyright notice.   This software may not
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    33
 be provided or otherwise made available to, or used by, any
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    34
 other person.  No title to or ownership of the software is
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    35
 hereby transferred.
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    36
"
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    37
!
7a569eca4d68 copyright
Claus Gittinger <cg@exept.de>
parents: 1487
diff changeset
    38
1487
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    39
documentation
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    40
"
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    41
    A TimedPromise is a Promise with a timeout.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    42
    An attempt to read the value of a TimedPromise will wait until the process has finished computing it 
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    43
    or the specified timeout expires.  
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    44
    If the process terminates with an exception, an attempt to read the value of the TimedPromise will raise the same exception. 
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    45
    In case of a timeout the OsNeedRetryError will be raised.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    46
"
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    47
!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    48
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    49
examples
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    50
"
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    51
                                                                    [exBegin]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    52
     |p|
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    53
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    54
     p := TimedPromise forMilliseconds:1000.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    55
     p value:[10000 factorial] priority:Processor activePriority.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    56
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    57
     Transcript showCR:'doing something else'.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    58
     p value   
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    59
                                                                    [exEnd]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    60
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    61
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    62
                                                                    [exBegin]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    63
     |p|
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    64
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    65
     p := TimedPromise forMilliseconds:1000.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    66
     p value:[1000 factorial] priority:Processor activePriority.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    67
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    68
     Transcript showCR:'doing something else'.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    69
     p value   
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    70
                                                                    [exEnd]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    71
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    72
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    73
                                                                    [exBegin]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    74
     |p|
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    75
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    76
     p := TimedPromise forMilliseconds:1000.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    77
     p value:[1000 factorial. ZeroDivide raise] priority:Processor activePriority.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    78
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    79
     Transcript showCR:'doing something else'.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    80
     p value   
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    81
                                                                    [exEnd]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    82
"
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    83
! !
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    84
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    85
!TimedPromise class methodsFor:'instance creation'!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    86
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    87
forMilliseconds: ms
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    88
        ^super new ms: ms.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    89
! !
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    90
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    91
!TimedPromise methodsFor:'accessing'!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    92
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    93
ms: msec
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    94
	ms := msec
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    95
! !
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    96
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    97
!TimedPromise methodsFor:'accessing-parent'!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    98
b243952bd3f1 initial checkin
penk
parents:
diff changeset
    99
value
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   100
        | whichSemaSignalled delaySemaphore |
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   101
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   102
        " Note -- only good for one waiter "
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   103
        delay notNil ifTrue:[
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   104
            self error:'Only one waiter allowed'.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   105
        ].
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   106
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   107
        self startup.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   108
        delay isNil ifTrue: [ ^ super value ].
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   109
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   110
        delaySemaphore := delay delaySemaphore.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   111
        whichSemaSignalled := (SemaphoreSet with:valueAvailable with:delaySemaphore) wait.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   112
        delay disable.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   113
        delay := nil.
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   114
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   115
        exception == nil
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   116
                ifTrue: [
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   117
                        whichSemaSignalled == delaySemaphore
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   118
                                ifTrue: [OSErrorHolder needRetrySignal raise]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   119
                                ifFalse: [^value]]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   120
                ifFalse: [exception raise "(exception copyForReraise) searchFrom: thisContext; raise"]
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   121
! !
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   122
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   123
!TimedPromise methodsFor:'private'!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   124
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   125
startup
3187
a5364888759b class: TimedPromise
Michael Beyl <mb@exept.de>
parents: 1522
diff changeset
   126
    "Wait for data arrival or alarm expiry."
a5364888759b class: TimedPromise
Michael Beyl <mb@exept.de>
parents: 1522
diff changeset
   127
4631
992198b2f876 #BUGFIX by stefan
Stefan Vogel <sv@exept.de>
parents: 3187
diff changeset
   128
    ms notNil ifTrue:[delay := Delay forMilliseconds:ms]
992198b2f876 #BUGFIX by stefan
Stefan Vogel <sv@exept.de>
parents: 3187
diff changeset
   129
992198b2f876 #BUGFIX by stefan
Stefan Vogel <sv@exept.de>
parents: 3187
diff changeset
   130
    "Modified: / 10-04-2018 / 09:49:01 / stefan"
1487
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   131
! !
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   132
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   133
!TimedPromise class methodsFor:'documentation'!
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   134
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   135
version
4631
992198b2f876 #BUGFIX by stefan
Stefan Vogel <sv@exept.de>
parents: 3187
diff changeset
   136
    ^ '$Header$'
1487
b243952bd3f1 initial checkin
penk
parents:
diff changeset
   137
! !
3187
a5364888759b class: TimedPromise
Michael Beyl <mb@exept.de>
parents: 1522
diff changeset
   138