Promise.st
author claus
Thu, 10 Aug 1995 20:36:43 +0200
changeset 85 df13b436b54e
parent 84 d401ce0001dc
child 112 3e18f2cfe430
permissions -rw-r--r--
.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
75
claus
parents: 71
diff changeset
     1
"
claus
parents: 71
diff changeset
     2
 COPYRIGHT (c) 1995 by Claus Gittinger
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
71
claus
parents:
diff changeset
    13
'From Smalltalk/X, Version:2.10.5 on 29-apr-1995 at 2:28:49 am'!
claus
parents:
diff changeset
    14
claus
parents:
diff changeset
    15
Object subclass:#Promise
claus
parents:
diff changeset
    16
	 instanceVariableNames:'value valueAvailable exception'
claus
parents:
diff changeset
    17
	 classVariableNames:''
claus
parents:
diff changeset
    18
	 poolDictionaries:''
claus
parents:
diff changeset
    19
	 category:'Kernel-Processes'
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
version
claus
parents: 71
diff changeset
    39
"
85
claus
parents: 84
diff changeset
    40
$Header: /cvs/stx/stx/libbasic2/Promise.st,v 1.4 1995-08-10 18:36:03 claus Exp $
75
claus
parents: 71
diff changeset
    41
"
claus
parents: 71
diff changeset
    42
!
claus
parents: 71
diff changeset
    43
claus
parents: 71
diff changeset
    44
documentation
claus
parents: 71
diff changeset
    45
"
claus
parents: 71
diff changeset
    46
    When created, a promise will start to evaluate its block in the background,
claus
parents: 71
diff changeset
    47
    and promise to deliver the value of this computation, when asked
claus
parents: 71
diff changeset
    48
    for it via #value. Promises can be used for background computations,
claus
parents: 71
diff changeset
    49
    which automatically block the user of the result when that result is needed,
claus
parents: 71
diff changeset
    50
    unless the computation finished in the meanwhile.
claus
parents: 71
diff changeset
    51
claus
parents: 71
diff changeset
    52
    See also Block>>promise and Lazy/Future in the goodies directory.
claus
parents: 71
diff changeset
    53
"
claus
parents: 71
diff changeset
    54
! !
claus
parents: 71
diff changeset
    55
71
claus
parents:
diff changeset
    56
!Promise class methodsFor:'instance creation'!
claus
parents:
diff changeset
    57
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
value:aBlock
claus
parents:
diff changeset
    65
    "create and return a Promise to evaluate aBlock at the current priority"
claus
parents:
diff changeset
    66
claus
parents:
diff changeset
    67
    ^ self new value:aBlock priority:Processor activePriority 
claus
parents:
diff changeset
    68
! !
claus
parents:
diff changeset
    69
claus
parents:
diff changeset
    70
!Promise methodsFor:'accessing'!
claus
parents:
diff changeset
    71
claus
parents:
diff changeset
    72
value
claus
parents:
diff changeset
    73
    "return the value of the promise. 
claus
parents:
diff changeset
    74
     If the evaluation process has not yet finished, wait for it.
claus
parents:
diff changeset
    75
     Otherwise return the value immediately.
claus
parents:
diff changeset
    76
     Any exception which occured during the evaluation is forwarded to the
claus
parents:
diff changeset
    77
     requestor of the value here."
claus
parents:
diff changeset
    78
claus
parents:
diff changeset
    79
    valueAvailable waitUncounted.
claus
parents:
diff changeset
    80
    exception notNil ifTrue:[
claus
parents:
diff changeset
    81
	"/
claus
parents:
diff changeset
    82
	"/ an exception occured while evaluating the promise.
claus
parents:
diff changeset
    83
	"/ This exception is remembered and raised here, when the
claus
parents:
diff changeset
    84
	"/ value is asked for.
claus
parents:
diff changeset
    85
	"/
claus
parents:
diff changeset
    86
	exception raise
claus
parents:
diff changeset
    87
    ].
claus
parents:
diff changeset
    88
    ^ value
claus
parents:
diff changeset
    89
!
claus
parents:
diff changeset
    90
claus
parents:
diff changeset
    91
value:aBlock priority:aPrio
claus
parents:
diff changeset
    92
    "setup and start the evaluation process."
claus
parents:
diff changeset
    93
claus
parents:
diff changeset
    94
    valueAvailable := Semaphore new:0.
claus
parents:
diff changeset
    95
claus
parents:
diff changeset
    96
    [
claus
parents:
diff changeset
    97
	Object errorSignal handle:[:ex |
claus
parents:
diff changeset
    98
	    exception := ex.
claus
parents:
diff changeset
    99
	    ex return.
claus
parents:
diff changeset
   100
	] do:[
claus
parents:
diff changeset
   101
	    value := aBlock value.
claus
parents:
diff changeset
   102
	].
claus
parents:
diff changeset
   103
	valueAvailable signal.
claus
parents:
diff changeset
   104
	valueAvailable signalForAll.
claus
parents:
diff changeset
   105
    ] forkAt:aPrio
claus
parents:
diff changeset
   106
claus
parents:
diff changeset
   107
    "
claus
parents:
diff changeset
   108
     Promise value:[100 timesRepeat:[1000 factorial]] priority:7
claus
parents:
diff changeset
   109
    "
claus
parents:
diff changeset
   110
    "
claus
parents:
diff changeset
   111
     Promise value:[10 timesRepeat:[1000 factorial]. [self halt] value.] priority:7
claus
parents:
diff changeset
   112
    "
claus
parents:
diff changeset
   113
! !
claus
parents:
diff changeset
   114
claus
parents:
diff changeset
   115
!Promise methodsFor:'queries'!
claus
parents:
diff changeset
   116
claus
parents:
diff changeset
   117
hasValue
claus
parents:
diff changeset
   118
    "return true, if the promise has a value avaliable.
claus
parents:
diff changeset
   119
     (i.e. if sending #value to it would NOT block)"
claus
parents:
diff changeset
   120
claus
parents:
diff changeset
   121
    ^ valueAvailable wouldBlock not
claus
parents:
diff changeset
   122
! !
claus
parents:
diff changeset
   123