Promise.st
author Claus Gittinger <cg@exept.de>
Fri, 29 Aug 2003 21:23:43 +0200
changeset 1307 18bf29731638
parent 485 fe9c2ff10461
child 1488 6b394aed47f7
permissions -rw-r--r--
*** empty log message ***
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
75
claus
parents: 71
diff changeset
     1
"
1307
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
     2
 COPYRIGHT (c) 1993 by Claus Gittinger
75
claus
parents: 71
diff changeset
     3
	      All Rights Reserved
claus
parents: 71
diff changeset
     4
claus
parents: 71
diff changeset
     5
 This software is furnished under a license and may be used
claus
parents: 71
diff changeset
     6
 only in accordance with the terms of that license and with the
claus
parents: 71
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
claus
parents: 71
diff changeset
     8
 be provided or otherwise made available to, or used by, any
claus
parents: 71
diff changeset
     9
 other person.  No title to or ownership of the software is
claus
parents: 71
diff changeset
    10
 hereby transferred.
claus
parents: 71
diff changeset
    11
"
claus
parents: 71
diff changeset
    12
1307
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    13
"{ Package: 'stx:libbasic2' }"
71
claus
parents:
diff changeset
    14
claus
parents:
diff changeset
    15
Object subclass:#Promise
1307
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    16
	instanceVariableNames:'value valueAvailable exception'
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    17
	classVariableNames:''
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    18
	poolDictionaries:''
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    19
	category:'Kernel-Processes'
71
claus
parents:
diff changeset
    20
!
claus
parents:
diff changeset
    21
75
claus
parents: 71
diff changeset
    22
!Promise class methodsFor:'documentation'!
claus
parents: 71
diff changeset
    23
claus
parents: 71
diff changeset
    24
copyright
claus
parents: 71
diff changeset
    25
"
claus
parents: 71
diff changeset
    26
 COPYRIGHT (c) 1993 by Claus Gittinger
claus
parents: 71
diff changeset
    27
	      All Rights Reserved
claus
parents: 71
diff changeset
    28
claus
parents: 71
diff changeset
    29
 This software is furnished under a license and may be used
claus
parents: 71
diff changeset
    30
 only in accordance with the terms of that license and with the
claus
parents: 71
diff changeset
    31
 inclusion of the above copyright notice.   This software may not
claus
parents: 71
diff changeset
    32
 be provided or otherwise made available to, or used by, any
claus
parents: 71
diff changeset
    33
 other person.  No title to or ownership of the software is
claus
parents: 71
diff changeset
    34
 hereby transferred.
claus
parents: 71
diff changeset
    35
"
claus
parents: 71
diff changeset
    36
!
claus
parents: 71
diff changeset
    37
claus
parents: 71
diff changeset
    38
documentation
claus
parents: 71
diff changeset
    39
"
claus
parents: 71
diff changeset
    40
    When created, a promise will start to evaluate its block in the background,
claus
parents: 71
diff changeset
    41
    and promise to deliver the value of this computation, when asked
claus
parents: 71
diff changeset
    42
    for it via #value. Promises can be used for background computations,
claus
parents: 71
diff changeset
    43
    which automatically block the user of the result when that result is needed,
claus
parents: 71
diff changeset
    44
    unless the computation finished in the meanwhile.
claus
parents: 71
diff changeset
    45
claus
parents: 71
diff changeset
    46
    See also Block>>promise and Lazy/Future in the goodies directory.
claus
parents: 71
diff changeset
    47
"
claus
parents: 71
diff changeset
    48
! !
claus
parents: 71
diff changeset
    49
71
claus
parents:
diff changeset
    50
!Promise class methodsFor:'instance creation'!
claus
parents:
diff changeset
    51
1307
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    52
value:aBlock
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    53
    "create and return a Promise to evaluate aBlock at the current priority"
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    54
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    55
    ^ self new value:aBlock priority:Processor activePriority 
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    56
!
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
    57
71
claus
parents:
diff changeset
    58
value:aBlock priority:aPrio
claus
parents:
diff changeset
    59
    "create and return a Promise to evaluate aBlock at some priority"
claus
parents:
diff changeset
    60
claus
parents:
diff changeset
    61
    ^ self new value:aBlock priority:aPrio
claus
parents:
diff changeset
    62
! !
claus
parents:
diff changeset
    63
claus
parents:
diff changeset
    64
!Promise methodsFor:'accessing'!
claus
parents:
diff changeset
    65
claus
parents:
diff changeset
    66
value
claus
parents:
diff changeset
    67
    "return the value of the promise. 
claus
parents:
diff changeset
    68
     If the evaluation process has not yet finished, wait for it.
claus
parents:
diff changeset
    69
     Otherwise return the value immediately.
claus
parents:
diff changeset
    70
     Any exception which occured during the evaluation is forwarded to the
claus
parents:
diff changeset
    71
     requestor of the value here."
claus
parents:
diff changeset
    72
claus
parents:
diff changeset
    73
    valueAvailable waitUncounted.
claus
parents:
diff changeset
    74
    exception notNil ifTrue:[
claus
parents:
diff changeset
    75
	"/
claus
parents:
diff changeset
    76
	"/ an exception occured while evaluating the promise.
claus
parents:
diff changeset
    77
	"/ This exception is remembered and raised here, when the
claus
parents:
diff changeset
    78
	"/ value is asked for.
claus
parents:
diff changeset
    79
	"/
claus
parents:
diff changeset
    80
	exception raise
claus
parents:
diff changeset
    81
    ].
claus
parents:
diff changeset
    82
    ^ value
claus
parents:
diff changeset
    83
!
claus
parents:
diff changeset
    84
claus
parents:
diff changeset
    85
value:aBlock priority:aPrio
claus
parents:
diff changeset
    86
    "setup and start the evaluation process."
claus
parents:
diff changeset
    87
485
fe9c2ff10461 added friendly semaphore names
Claus Gittinger <cg@exept.de>
parents: 189
diff changeset
    88
    valueAvailable := (Semaphore new:0) name:'valueAvailable'.
71
claus
parents:
diff changeset
    89
claus
parents:
diff changeset
    90
    [
189
c2e0b4299f9e *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 112
diff changeset
    91
	ErrorSignal handle:[:ex |
71
claus
parents:
diff changeset
    92
	    exception := ex.
claus
parents:
diff changeset
    93
	    ex return.
claus
parents:
diff changeset
    94
	] do:[
claus
parents:
diff changeset
    95
	    value := aBlock value.
claus
parents:
diff changeset
    96
	].
claus
parents:
diff changeset
    97
	valueAvailable signal.
claus
parents:
diff changeset
    98
	valueAvailable signalForAll.
claus
parents:
diff changeset
    99
    ] forkAt:aPrio
claus
parents:
diff changeset
   100
claus
parents:
diff changeset
   101
    "
claus
parents:
diff changeset
   102
     Promise value:[100 timesRepeat:[1000 factorial]] priority:7
claus
parents:
diff changeset
   103
    "
claus
parents:
diff changeset
   104
    "
claus
parents:
diff changeset
   105
     Promise value:[10 timesRepeat:[1000 factorial]. [self halt] value.] priority:7
claus
parents:
diff changeset
   106
    "
claus
parents:
diff changeset
   107
! !
claus
parents:
diff changeset
   108
claus
parents:
diff changeset
   109
!Promise methodsFor:'queries'!
claus
parents:
diff changeset
   110
claus
parents:
diff changeset
   111
hasValue
claus
parents:
diff changeset
   112
    "return true, if the promise has a value avaliable.
claus
parents:
diff changeset
   113
     (i.e. if sending #value to it would NOT block)"
claus
parents:
diff changeset
   114
claus
parents:
diff changeset
   115
    ^ valueAvailable wouldBlock not
claus
parents:
diff changeset
   116
! !
claus
parents:
diff changeset
   117
1307
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
   118
!Promise class methodsFor:'documentation'!
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
   119
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
   120
version
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
   121
    ^ '$Header: /cvs/stx/stx/libbasic2/Promise.st,v 1.8 2003-08-29 19:23:33 cg Exp $'
18bf29731638 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 485
diff changeset
   122
! !