Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
| 2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
| 3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * Concurrent programming using _isolates_: | 6 * Concurrent programming using _isolates_: |
| 7 * independent workers that are similar to threads | 7 * independent workers that are similar to threads |
| 8 * but don't share memory, | 8 * but don't share memory, |
| 9 * communicating only via messages. | 9 * communicating only via messages. |
| 10 * | 10 * |
| 11 * See also: | 11 * See also: |
| 12 * [dart:isolate - Concurrency with Isolates](https://www.dartlang.org/docs/dart -up-and-running/contents/ch03.html#ch03-dartisolate---concurrency-with-isolates) | 12 * [dart:isolate - Concurrency with Isolates](https://www.dartlang.org/docs/dart -up-and-running/contents/ch03.html#ch03-dartisolate---concurrency-with-isolates) |
| 13 * in the library tour. | 13 * in the library tour. |
| 14 */ | 14 */ |
| 15 library dart.isolate; | 15 library dart.isolate; |
| 16 | 16 |
| 17 import "dart:async"; | 17 import "dart:async"; |
| 18 | 18 |
| 19 part "isolate_stream.dart"; | 19 /** |
| 20 | 20 * Thrown when an isolate cannot be created. |
| 21 */ | |
| 21 class IsolateSpawnException implements Exception { | 22 class IsolateSpawnException implements Exception { |
| 22 const IsolateSpawnException(String this._s); | 23 const IsolateSpawnException(); |
| 23 String toString() => "IsolateSpawnException: '$_s'"; | |
| 24 final String _s; | |
| 25 } | 24 } |
| 26 | 25 |
| 27 /** | 26 /// *DEPRECATED*. |
| 28 * The initial ReceivePort available by default for this isolate. | |
| 29 * | |
| 30 * This ReceivePort is created automatically | |
| 31 * and is commonly used to establish | |
| 32 * the first communication between isolates. | |
| 33 * (See [spawnFunction] and [spawnUri].) | |
| 34 */ | |
| 35 ReceivePort get port => _Isolate.port; | 27 ReceivePort get port => _Isolate.port; |
| 36 | 28 |
| 37 /** | 29 class Isolate { |
| 38 * Creates and spawns an isolate | |
| 39 * that shares the same code as the current isolate, | |
| 40 * but that starts from the specified function. | |
| 41 * | |
| 42 * The [topLevelFunction] argument must be | |
| 43 * a static top-level function or a static method that takes no | |
| 44 * arguments. It is illegal to pass a function closure. | |
| 45 * | |
| 46 * When any isolate starts (even the main script of the application), a default | |
| 47 * [ReceivePort] is created for it. This port is available from the top-level | |
| 48 * getter [port] defined in this library. | |
| 49 * | |
| 50 * This function returns a [SendPort] derived from | |
| 51 * the child isolate's default port. | |
| 52 * | |
| 53 * The optional [unhandledExceptionCallback] argument is invoked whenever an | |
| 54 * exception inside the isolate is unhandled. It can be seen as a big | |
| 55 * `try/catch` around everything that is executed inside the isolate. The | |
| 56 * callback should return `true` if it was able to handle the exception. | |
| 57 */ | |
| 58 SendPort spawnFunction(void topLevelFunction(), | |
| 59 [bool unhandledExceptionCallback(IsolateUnhandledException e)]) | |
| 60 => _Isolate.spawnFunction(topLevelFunction, unhandledExceptionCallback); | |
| 61 | 30 |
| 62 /** | 31 final SendPort _controlPort; |
| 63 * Creates and spawns an isolate that runs the code from the specified URI. | 32 |
| 64 * | 33 Isolate._fromControlPort(this._controlPort); |
| 65 * As with [spawnFunction], | 34 |
| 66 * the child isolate has a default [ReceivePort], | 35 /** |
| 67 * and this function returns a [SendPort] derived from it. | 36 * Creates and spawns an isolate that shares the same code as the current |
| 68 */ | 37 * isolate. |
| 38 * | |
| 39 * The argument [entryPoint] specifies the entry point of the spawned | |
| 40 * isolate. It must be a static top-level function or a static method that | |
| 41 * takes no arguments. It is not allowed to pass a function closure. | |
| 42 * | |
| 43 * The entry-point function is invoked with the initial [message]. | |
| 44 * Usually the initial [message] contains a [SendPort] so | |
| 45 * that the spawner and spawnee can communicate with each other. | |
| 46 * | |
| 47 * Returns a future that will complete with an [Isolate] instance. The | |
| 48 * isolate instance can be used to control the spawned isolate. | |
| 49 */ | |
| 50 external static Future<Isolate> spawn(void entryPoint(message), var message); | |
|
Lasse Reichstein Nielsen
2013/10/17 12:26:54
Documentation says: "takes no arguments". This req
floitsch
2013/10/17 12:30:56
Yes. this came up yesterday.
Would be ok, and fund
| |
| 51 | |
| 52 /** | |
| 53 * Creates and spawns an isolate that runs the code from the library with | |
| 54 * the specified URI. | |
| 55 * | |
| 56 * The isolate starts executing the top-level `main` function of the library | |
| 57 * with the given URI. Otherwise similar to [spawn]. | |
| 58 */ | |
| 59 external static Future<Isolate> spawnUri(Uri uri, var arguments); | |
| 60 } | |
| 61 | |
| 62 /// *DEPRECATED*. | |
| 69 SendPort spawnUri(String uri) => _Isolate.spawnUri(uri); | 63 SendPort spawnUri(String uri) => _Isolate.spawnUri(uri); |
| 70 | 64 |
| 71 /** | 65 /** |
| 72 * Together with [ReceivePort], | 66 * Sends messages to its [ReceivePort]s. |
| 73 * the only means of communication between isolates. | |
| 74 * | 67 * |
| 75 * [SendPort]s are created from [ReceivePort]s. Any message sent through | 68 * [SendPort]s are created from [ReceivePort]s. Any message sent through |
| 76 * a [SendPort] is delivered to its respective [ReceivePort]. There might be | 69 * a [SendPort] is delivered to its respective [ReceivePort]. There might be |
| 77 * many [SendPort]s for the same [ReceivePort]. | 70 * many [SendPort]s for the same [ReceivePort]. |
| 78 * | 71 * |
| 79 * [SendPort]s can be transmitted to other isolates. | 72 * [SendPort]s can be transmitted to other isolates. |
| 80 */ | 73 */ |
| 81 abstract class SendPort { | 74 abstract class SendPort { |
| 82 | 75 |
| 83 /** | 76 /** |
| 84 * Sends an asynchronous [message] to this send port. The message is copied to | 77 * Sends an asynchronous [message] to this send port. The message is copied to |
| 85 * the receiving isolate. If specified, the [replyTo] port will be provided to | 78 * the receiving isolate. |
| 86 * the receiver to facilitate exchanging sequences of messages. | |
| 87 * | 79 * |
| 88 * The content of [message] can be: primitive values (null, num, bool, double, | 80 * The content of [message] can be: primitive values (null, num, bool, double, |
| 89 * String), instances of [SendPort], and lists and maps whose elements are any | 81 * String), instances of [SendPort], and lists and maps whose elements are any |
| 90 * of these. List and maps are also allowed to be cyclic. | 82 * of these. List and maps are also allowed to be cyclic. |
| 91 * | 83 * |
| 92 * In the special circumstances when two isolates share the same code and are | 84 * In the special circumstances when two isolates share the same code and are |
| 93 * running in the same process (e.g. isolates created via [spawnFunction]), it | 85 * running in the same process (e.g. isolates created via [spawnFunction]), it |
| 94 * is also possible to send object instances (which would be copied in the | 86 * is also possible to send object instances (which would be copied in the |
| 95 * process). This is currently only supported by the dartvm. For now, the | 87 * process). This is currently only supported by the dartvm. For now, the |
| 96 * dart2js compiler only supports the restricted messages described above. | 88 * dart2js compiler only supports the restricted messages described above. |
| 97 * | 89 * |
| 98 * Deprecation note: it is no longer valid to transmit a [ReceivePort] in a | 90 * The second argument [replyTo] is deprecated. |
| 99 * message. Previously they were translated to the corresponding send port | |
| 100 * before being transmitted. | |
| 101 */ | 91 */ |
| 102 void send(var message, [SendPort replyTo]); | 92 void send(var message, [SendPort replyTo]); |
| 103 | 93 |
| 104 /** | 94 /** |
| 105 * Sends a message to this send port and returns a [Future] of the reply. | |
| 106 * Basically, this internally creates a new receive port, sends a | |
| 107 * message to this send port with replyTo set to such receive port, and, when | |
| 108 * a reply is received, it closes the receive port and completes the returned | |
| 109 * future. | |
| 110 */ | |
| 111 Future call(var message); | |
| 112 | |
| 113 /** | |
| 114 * Tests whether [other] is a [SendPort] pointing to the same | 95 * Tests whether [other] is a [SendPort] pointing to the same |
| 115 * [ReceivePort] as this one. | 96 * [ReceivePort] as this one. |
| 116 */ | 97 */ |
| 117 bool operator==(var other); | 98 bool operator==(var other); |
| 118 | 99 |
| 119 /** | 100 /** |
| 120 * Returns an immutable hash code for this send port that is | 101 * Returns an immutable hash code for this send port that is |
| 121 * consistent with the == operator. | 102 * consistent with the == operator. |
| 122 */ | 103 */ |
| 123 int get hashCode; | 104 int get hashCode; |
| 124 | |
| 125 } | |
| 126 | |
| 127 /** | |
| 128 * Together with [SendPort], the only means of | |
| 129 * communication between isolates. | |
| 130 * | |
| 131 * [ReceivePort]s have a [:toSendPort:] method | |
| 132 * which returns a [SendPort]. Any message that is sent through this [SendPort] | |
| 133 * is delivered to the [ReceivePort] it has been created from. There, they are | |
| 134 * dispatched to the callback that has been registered on the receive port. | |
| 135 * | |
| 136 * A [ReceivePort] may have many [SendPort]s. | |
| 137 */ | |
| 138 abstract class ReceivePort { | |
| 139 | |
| 140 /** | |
| 141 * Opens a long-lived port for receiving messages. The returned port | |
| 142 * must be explicitly closed through [ReceivePort.close]. | |
| 143 */ | |
| 144 external factory ReceivePort(); | |
| 145 | |
| 146 /** | |
| 147 * Sets up a callback function for receiving pending or future | |
| 148 * messages on this receive port. | |
| 149 */ | |
| 150 void receive(void callback(var message, SendPort replyTo)); | |
| 151 | |
| 152 /** | |
| 153 * Closes this receive port immediately. Pending messages will not | |
| 154 * be processed and it is impossible to re-open the port. Single-shot | |
| 155 * reply ports, such as those created through [SendPort.call], are | |
| 156 * automatically closed when the reply has been received. Multiple | |
| 157 * invocations of [close] are allowed but ignored. | |
| 158 */ | |
| 159 void close(); | |
| 160 | |
| 161 /** | |
| 162 * Creates a new send port that sends to this receive port. It is legal to | |
| 163 * create several [SendPort]s from the same [ReceivePort]. | |
| 164 */ | |
| 165 SendPort toSendPort(); | |
| 166 | |
| 167 } | |
| 168 | |
| 169 /** | |
| 170 * [SendPortSync]s are created from [ReceivePortSync]s. Any message sent through | |
| 171 * a [SendPortSync] is delivered to its respective [ReceivePortSync]. There | |
| 172 * might be many [SendPortSync]s for the same [ReceivePortSync]. | |
| 173 * | |
| 174 * [SendPortSync]s can be transmitted to other isolates. | |
| 175 */ | |
| 176 abstract class SendPortSync { | |
| 177 /** | |
| 178 * Sends a synchronous message to this send port and returns the result. | |
| 179 */ | |
| 180 callSync(var message); | |
| 181 | |
| 182 /** | |
| 183 * Tests whether [other] is a [SendPortSync] pointing to the same | |
| 184 * [ReceivePortSync] as this one. | |
| 185 */ | |
| 186 bool operator==(var other); | |
| 187 | |
| 188 /** | |
| 189 * Returns an immutable hash code for this send port that is | |
| 190 * consistent with the == operator. | |
| 191 */ | |
| 192 int get hashCode; | |
| 193 } | 105 } |
| 194 | 106 |
| 107 /** | |
| 108 * Together with [SendPort], the only means of communication between isolates. | |
| 109 * | |
| 110 * [ReceivePort]s have a `sendport` getter which returns a [SendPort]. | |
| 111 * Any message that is sent through this [SendPort] | |
| 112 * is delivered to the [ReceivePort] it has been created from. There, the | |
| 113 * message is dispatched to its listener. | |
| 114 * | |
| 115 * A [ReceivePort] is a non-broadcast stream. This means that it buffers | |
| 116 * incoming messages until a listener is registered. Only one listener can | |
| 117 * receive messages. See [Stream.asBroadcastStream] for transforming the port | |
| 118 * to a broadcast stream. | |
| 119 * | |
| 120 * A [ReceivePort] may have many [SendPort]s. | |
| 121 */ | |
| 122 abstract class ReceivePort implements Stream { | |
| 123 | |
| 124 /** | |
| 125 * Opens a long-lived port for receiving messages. | |
| 126 * | |
| 127 * A [ReceivePort] is a non-broadcast stream. This means that it buffers | |
| 128 * incoming messages until a listener is registered. Only one listener can | |
| 129 * receive messages. See [Stream.asBroadcastStream] for transforming the port | |
| 130 * to a broadcast stream. | |
| 131 * | |
| 132 * A receive port is closed by canceling its subscription. | |
| 133 */ | |
| 134 external factory ReceivePort(); | |
| 135 | |
| 136 /** | |
| 137 * Inherited from [Stream]. | |
| 138 * | |
| 139 * Note that all named arguments are ignored since a ReceivePort will never | |
| 140 * receive an error, or done message. | |
| 141 */ | |
| 142 StreamSubscription listen(void onData(var message), | |
| 143 { Function onError, | |
| 144 void onDone(), | |
| 145 bool cancelOnError }); | |
| 146 | |
| 147 /** | |
| 148 * Closes `this`. | |
| 149 * | |
| 150 * If the stream has not been canceled yet, adds a close-event to the event | |
| 151 * queue and discards any further incoming messages. | |
| 152 * | |
| 153 * If the stream has already been canceled this method has no effect. | |
| 154 */ | |
| 155 void close(); | |
| 156 | |
| 157 /** | |
| 158 * Returns a send port that sends to this receive port. | |
| 159 */ | |
| 160 SendPort get sendPort; | |
| 161 } | |
| 162 | |
| 195 // The VM doesn't support accessing external globals in the same library. We | 163 // The VM doesn't support accessing external globals in the same library. We |
| 196 // therefore create this wrapper class. | 164 // therefore create this wrapper class. |
| 197 // TODO(6997): Don't go through static class for external variables. | 165 // TODO(6997): Don't go through static class for external variables. |
| 198 abstract class _Isolate { | 166 abstract class _Isolate { |
| 199 external static ReceivePort get port; | 167 external static ReceivePort get port; |
| 200 external static SendPort spawnFunction(void topLevelFunction(), | |
| 201 [bool unhandledExceptionCallback(IsolateUnhandledException e)]); | |
| 202 external static SendPort spawnUri(String uri); | 168 external static SendPort spawnUri(String uri); |
| 203 } | 169 } |
| 204 | 170 |
| 205 /** | 171 /** |
| 206 * Wraps unhandled exceptions thrown during isolate execution. It is | 172 * Wraps unhandled exceptions thrown during isolate execution. It is |
| 207 * used to show both the error message and the stack trace for unhandled | 173 * used to show both the error message and the stack trace for unhandled |
| 208 * exceptions. | 174 * exceptions. |
| 209 */ | 175 */ |
| 176 // TODO(floitsch): probably going to remove and replace with something else. | |
| 210 class IsolateUnhandledException implements Exception { | 177 class IsolateUnhandledException implements Exception { |
| 211 /** Message being handled when exception occurred. */ | 178 /** Message being handled when exception occurred. */ |
| 212 final message; | 179 final message; |
| 213 | 180 |
| 214 /** Wrapped exception. */ | 181 /** Wrapped exception. */ |
| 215 final source; | 182 final source; |
| 216 | 183 |
| 217 /** Trace for the wrapped exception. */ | 184 /** Trace for the wrapped exception. */ |
| 218 final Object stackTrace; | 185 final Object stackTrace; |
| 219 | 186 |
| 220 const IsolateUnhandledException(this.message, this.source, this.stackTrace); | 187 const IsolateUnhandledException(this.message, this.source, this.stackTrace); |
| 221 | 188 |
| 222 String toString() { | 189 String toString() { |
| 223 return 'IsolateUnhandledException: exception while handling message: ' | 190 return 'IsolateUnhandledException: exception while handling message: ' |
| 224 '${message} \n ' | 191 '${message} \n ' |
| 225 '${source.toString().replaceAll("\n", "\n ")}\n' | 192 '${source.toString().replaceAll("\n", "\n ")}\n' |
| 226 'original stack trace:\n ' | 193 'original stack trace:\n ' |
| 227 '${stackTrace.toString().replaceAll("\n","\n ")}'; | 194 '${stackTrace.toString().replaceAll("\n","\n ")}'; |
| 228 } | 195 } |
| 229 } | 196 } |
| OLD | NEW |