| 1 | | | part of '_channel.dart'; |
| 2 | | | |
| 3 | | | /// [Channel] implementation for the Native world. |
| 4 | | | final class _VmChannel implements Channel { |
| 5 | | 10 | _VmChannel._(this._sendPort, this.logger, this.exceptionManager); |
| 6 | | | |
| 7 | | | /// [vm.SendPort] to communicate with the [vm.Isolate] if the channel is owned by |
| 8 | | | /// the worker owner. Otherwise, [vm.SendPort] to return values to the client. |
| 9 | | | final vm.SendPort _sendPort; |
| 10 | | | |
| 11 | | | PlatformThread? _thread; |
| 12 | | | final _activeConnections = <ForwardStreamController<WorkerResponse>>[]; |
| 13 | | | |
| 14 | | | @override |
| 15 | | | final ExceptionManager exceptionManager; |
| 16 | | | |
| 17 | | | @override |
| 18 | | | final Logger? logger; |
| 19 | | | |
| 20 | | | final _closed = Completer<void>(); |
| 21 | | | |
| 22 | | 1 | @override |
| 23 | | 2 | Future<void> get closed => _closed.future; |
| 24 | | | |
| 25 | | | /// [Channel] serialization in Native world returns the [vm.SendPort]. |
| 26 | | 3 | @override |
| 27 | | 3 | PlatformChannel serialize() => _sendPort; |
| 28 | | | |
| 29 | | | /// [Channel] sharing in native world returns a [_VmForwardChannel]. |
| 30 | | 3 | @override |
| 31 | | 3 | Channel share() => _VmForwardChannel._( |
| 32 | | 12 | _sendPort, vm.ReceivePort(), logger, exceptionManager); |
| 33 | | | |
| 34 | | 10 | void _postRequest(WorkerRequest req, {bool force = false}) { |
| 35 | | 20 | if (_closed.isCompleted && !force) { |
| 36 | | 0 | throw SquadronErrorImpl.create('Channel is closed'); |
| 37 | | | } |
| 38 | | | try { |
| 39 | | 12 | req.cancelToken?.ensureStarted(); |
| 40 | | 10 | req.wrapInPlace(); |
| 41 | | 20 | _sendPort.send(req); |
| 42 | | | } catch (ex, st) { |
| 43 | | 1 | logger?.e(() => 'Failed to post request $req: $ex'); |
| 44 | | 2 | throw SquadronErrorImpl.create('Failed to post request: $ex', st); |
| 45 | | | } |
| 46 | | | } |
| 47 | | | |
| 48 | | | /// Sends a termination [WorkerRequest] to the [vm.Isolate]. |
| 49 | | 10 | @override |
| 50 | | | Future<void> close() { |
| 51 | | 20 | if (!_closed.isCompleted) { |
| 52 | | 20 | _postRequest(WorkerRequest.stop()); |
| 53 | | 20 | _closed.complete(); |
| 54 | | | } |
| 55 | | 20 | return _closed.future; |
| 56 | | | } |
| 57 | | | |
| 58 | | | /// Sends a close stream [WorkerRequest] to the [vm.Isolate]. |
| 59 | | 4 | @override |
| 60 | | | void cancelStream(int streamId) { |
| 61 | | 8 | _postRequest(WorkerRequest.cancelStream(streamId), force: true); |
| 62 | | | } |
| 63 | | | |
| 64 | | | /// Sends a cancel token [WorkerRequest] to the [vm.Isolate]. |
| 65 | | 2 | @override |
| 66 | | | void cancelToken(SquadronCancelationToken? token) { |
| 67 | | | if (token != null) { |
| 68 | | 4 | _postRequest(WorkerRequest.cancel(token), force: true); |
| 69 | | | } |
| 70 | | | } |
| 71 | | | |
| 72 | | 10 | void _enter(ForwardStreamController<WorkerResponse> controller) { |
| 73 | | 20 | _activeConnections.add(controller); |
| 74 | | | } |
| 75 | | | |
| 76 | | 10 | void _leave(ForwardStreamController<WorkerResponse> controller) { |
| 77 | | 20 | _activeConnections.remove(controller); |
| 78 | | 10 | controller.close(); |
| 79 | | | } |
| 80 | | | |
| 81 | | 10 | Stream<dynamic> _getResponseStream( |
| 82 | | | vm.ReceivePort port, |
| 83 | | | WorkerRequest req, |
| 84 | | | void Function(WorkerRequest) post, { |
| 85 | | | required bool streaming, |
| 86 | | | }) { |
| 87 | | 10 | final command = req.command; |
| 88 | | | |
| 89 | | | // send the request, return a stream of responses |
| 90 | | 10 | Stream<WorkerResponse> $sendRequest() { |
| 91 | | | late final ForwardStreamController<WorkerResponse> controller; |
| 92 | | | |
| 93 | | 1 | void $forwardError(Object error, [StackTrace? st]) => |
| 94 | | 2 | controller.safeAddError(SquadronException.from(error, st, command)); |
| 95 | | | |
| 96 | | 20 | controller = ForwardStreamController(onListen: () { |
| 97 | | | // do nothing if the controller is closed already |
| 98 | | 10 | if (controller.isClosed) return; |
| 99 | | | |
| 100 | | | // bind the controller |
| 101 | | 30 | controller.attachSubscription(port.cast<WorkerResponse>().listen( |
| 102 | | 10 | controller.safeAdd, |
| 103 | | | onError: $forwardError, |
| 104 | | 0 | onDone: () => _leave(controller), |
| 105 | | | cancelOnError: false, |
| 106 | | | )); |
| 107 | | | |
| 108 | | | // send the request |
| 109 | | | try { |
| 110 | | 10 | _enter(controller); |
| 111 | | 10 | post(req); |
| 112 | | | } catch (ex, st) { |
| 113 | | 1 | $forwardError(ex, st); |
| 114 | | 1 | _leave(controller); |
| 115 | | | } |
| 116 | | 10 | }, onCancel: () { |
| 117 | | 10 | _leave(controller); |
| 118 | | | }); |
| 119 | | 10 | return controller.stream; |
| 120 | | | } |
| 121 | | | |
| 122 | | | // return a stream of decoded responses |
| 123 | | 10 | final res = ResultStream(this, req, $sendRequest, streaming); |
| 124 | | 50 | res.done.whenComplete(() => port.close()).ignore(); |
| 125 | | 10 | return res.stream; |
| 126 | | | } |
| 127 | | | |
| 128 | | | /// creates a [vm.ReceivePort] and a [WorkerRequest] and sends it to the |
| 129 | | | /// [vm.Isolate]. This method expects a single value from the [Isolate] |
| 130 | | 10 | @override |
| 131 | | | Future<dynamic> sendRequest( |
| 132 | | | int command, |
| 133 | | | List args, { |
| 134 | | | SquadronCancelationToken? token, |
| 135 | | | bool inspectRequest = false, |
| 136 | | | bool inspectResponse = false, |
| 137 | | | }) { |
| 138 | | 10 | final completer = Completer(); |
| 139 | | | late final StreamSubscription sub; |
| 140 | | | |
| 141 | | 10 | void $success(dynamic data) { |
| 142 | | 40 | sub.cancel().whenComplete(() => completer.safeComplete(data)); |
| 143 | | | } |
| 144 | | | |
| 145 | | 4 | void $failure(Object ex, [StackTrace? st]) { |
| 146 | | 16 | sub.cancel().whenComplete(() => completer.safeCompleteError(ex, st)); |
| 147 | | | } |
| 148 | | | |
| 149 | | 0 | void $done() { |
| 150 | | 0 | sub.cancel().whenComplete(() { |
| 151 | | 0 | if (!completer.isCompleted) { |
| 152 | | 0 | $failure(WorkerException('No response from worker', null, command)); |
| 153 | | | } |
| 154 | | | }); |
| 155 | | | } |
| 156 | | | |
| 157 | | 10 | final receiver = vm.ReceivePort(); |
| 158 | | 10 | final req = WorkerRequest.userCommand( |
| 159 | | 10 | receiver.sendPort, command, args, token, inspectResponse); |
| 160 | | 20 | sub = _getResponseStream(receiver, req, _postRequest, streaming: false) |
| 161 | | 10 | .listen($success, onError: $failure, onDone: $done); |
| 162 | | 10 | return completer.future; |
| 163 | | | } |
| 164 | | | |
| 165 | | | /// Creates a [vm.ReceivePort] and a [WorkerRequest] and sends it to the |
| 166 | | | /// [vm.Isolate]. This method expects a stream of values from the [vm.Isolate]. |
| 167 | | | /// The [vm.Isolate] must send a [WorkerResponse.endOfStream] to close the |
| 168 | | | /// [Stream]. |
| 169 | | 5 | @override |
| 170 | | | Stream<dynamic> sendStreamingRequest( |
| 171 | | | int command, |
| 172 | | | List args, { |
| 173 | | | SquadronCancelationToken? token, |
| 174 | | | bool inspectRequest = false, |
| 175 | | | bool inspectResponse = false, |
| 176 | | | }) { |
| 177 | | 5 | final receiver = vm.ReceivePort(); |
| 178 | | 5 | final req = WorkerRequest.userCommand( |
| 179 | | 5 | receiver.sendPort, command, args, token, inspectResponse); |
| 180 | | 10 | return _getResponseStream(receiver, req, _postRequest, streaming: true); |
| 181 | | | } |
| 182 | | | } |