Jorge Canizales | 9409ad8 | 2015-02-18 16:19:56 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Yang Gao | 5fc9029 | 2015-02-20 09:46:22 -0800 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Jorge Canizales | 9409ad8 | 2015-02-18 16:19:56 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 34 | #import "GRPCCall.h" |
| 35 | |
Jorge Canizales | c2d7ecb | 2015-02-27 01:22:41 -0800 | [diff] [blame] | 36 | #include <grpc/grpc.h> |
Jorge Canizales | 59bb9d7 | 2015-06-22 19:04:15 -0700 | [diff] [blame] | 37 | #include <grpc/support/time.h> |
Jorge Canizales | 35f003b | 2015-07-17 21:14:36 -0700 | [diff] [blame] | 38 | #import <RxLibrary/GRXConcurrentWriteable.h> |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 39 | |
Jorge Canizales | 2f10127 | 2015-09-02 21:55:37 -0700 | [diff] [blame^] | 40 | #import "private/GRPCRequestHeaders.h" |
murgatroid99 | 69927d6 | 2015-04-24 13:32:48 -0700 | [diff] [blame] | 41 | #import "private/GRPCWrappedCall.h" |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 42 | #import "private/NSData+GRPC.h" |
| 43 | #import "private/NSDictionary+GRPC.h" |
| 44 | #import "private/NSError+GRPC.h" |
| 45 | |
Jorge Canizales | 1ab2a71 | 2015-08-12 20:32:11 -0700 | [diff] [blame] | 46 | NSString * const kGRPCHeadersKey = @"io.grpc.HeadersKey"; |
| 47 | NSString * const kGRPCTrailersKey = @"io.grpc.TrailersKey"; |
Jorge Canizales | f3a4f2c | 2015-06-12 22:12:50 -0700 | [diff] [blame] | 48 | |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 49 | @interface GRPCCall () <GRXWriteable> |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 50 | // Make them read-write. |
| 51 | @property(atomic, strong) NSDictionary *responseHeaders; |
| 52 | @property(atomic, strong) NSDictionary *responseTrailers; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 53 | @end |
| 54 | |
| 55 | // The following methods of a C gRPC call object aren't reentrant, and thus |
| 56 | // calls to them must be serialized: |
murgatroid99 | b5c076f | 2015-04-27 17:25:36 -0700 | [diff] [blame] | 57 | // - start_batch |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 58 | // - destroy |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 59 | // |
murgatroid99 | b5c076f | 2015-04-27 17:25:36 -0700 | [diff] [blame] | 60 | // start_batch with a SEND_MESSAGE argument can only be called after the |
| 61 | // OP_COMPLETE event for any previous write is received. This is achieved by |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 62 | // pausing the requests writer immediately every time it writes a value, and |
murgatroid99 | b5c076f | 2015-04-27 17:25:36 -0700 | [diff] [blame] | 63 | // resuming it again when OP_COMPLETE is received. |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 64 | // |
murgatroid99 | b5c076f | 2015-04-27 17:25:36 -0700 | [diff] [blame] | 65 | // Similarly, start_batch with a RECV_MESSAGE argument can only be called after |
| 66 | // the OP_COMPLETE event for any previous read is received.This is easier to |
| 67 | // enforce, as we're writing the received messages into the writeable: |
| 68 | // start_batch is enqueued once upon receiving the OP_COMPLETE event for the |
| 69 | // RECV_METADATA batch, and then once after receiving each OP_COMPLETE event for |
| 70 | // each RECV_MESSAGE batch. |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 71 | @implementation GRPCCall { |
| 72 | dispatch_queue_t _callQueue; |
| 73 | |
murgatroid99 | 30b7d4e | 2015-04-24 10:36:43 -0700 | [diff] [blame] | 74 | GRPCWrappedCall *_wrappedCall; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 75 | dispatch_once_t _callAlreadyInvoked; |
| 76 | |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 77 | // The C gRPC library has less guarantees on the ordering of events than we |
| 78 | // do. Particularly, in the face of errors, there's no ordering guarantee at |
| 79 | // all. This wrapper over our actual writeable ensures thread-safety and |
| 80 | // correct ordering. |
Jorge Canizales | 35f003b | 2015-07-17 21:14:36 -0700 | [diff] [blame] | 81 | GRXConcurrentWriteable *_responseWriteable; |
Jorge Canizales | 238ad78 | 2015-08-07 23:11:29 -0700 | [diff] [blame] | 82 | |
| 83 | // The network thread wants the requestWriter to resume (when the server is ready for more input), |
| 84 | // or to stop (on errors), concurrently with user threads that want to start it, pause it or stop |
| 85 | // it. Because a writer isn't thread-safe, we'll synchronize those operations on it. |
| 86 | // We don't use a dispatch queue for that purpose, because the writer can call writeValue: or |
| 87 | // writesFinishedWithError: on this GRPCCall as part of those operations. We want to be able to |
| 88 | // pause the writer immediately on writeValue:, so we need our locking to be recursive. |
Jorge Canizales | 5604712 | 2015-07-17 12:18:08 -0700 | [diff] [blame] | 89 | GRXWriter *_requestWriter; |
Jorge Canizales | 544963e | 2015-06-12 19:46:27 -0700 | [diff] [blame] | 90 | |
Jorge Canizales | 6531b2b | 2015-07-18 00:19:14 -0700 | [diff] [blame] | 91 | // To create a retain cycle when a call is started, up until it finishes. See |
Jorge Canizales | eb87b46 | 2015-08-08 16:16:43 -0700 | [diff] [blame] | 92 | // |startWithWriteable:| and |finishWithError:|. This saves users from having to retain a |
| 93 | // reference to the call object if all they're interested in is the handler being executed when |
| 94 | // the response arrives. |
| 95 | GRPCCall *_retainSelf; |
Jorge Canizales | 6531b2b | 2015-07-18 00:19:14 -0700 | [diff] [blame] | 96 | |
murgatroid99 | 84fa531 | 2015-08-28 10:55:55 -0700 | [diff] [blame] | 97 | GRPCRequestHeaders *_requestHeaders; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | @synthesize state = _state; |
| 101 | |
| 102 | - (instancetype)init { |
Jorge Canizales | be808e3 | 2015-07-04 14:37:58 -0700 | [diff] [blame] | 103 | return [self initWithHost:nil path:nil requestsWriter:nil]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | // Designated initializer |
| 107 | - (instancetype)initWithHost:(NSString *)host |
Jorge Canizales | be808e3 | 2015-07-04 14:37:58 -0700 | [diff] [blame] | 108 | path:(NSString *)path |
Jorge Canizales | 5604712 | 2015-07-17 12:18:08 -0700 | [diff] [blame] | 109 | requestsWriter:(GRXWriter *)requestWriter { |
Jorge Canizales | be808e3 | 2015-07-04 14:37:58 -0700 | [diff] [blame] | 110 | if (!host || !path) { |
Jorge Canizales | 597ef98 | 2015-07-31 23:31:56 -0700 | [diff] [blame] | 111 | [NSException raise:NSInvalidArgumentException format:@"Neither host nor path can be nil."]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 112 | } |
Jorge Canizales | 6bbfcc3 | 2015-06-17 14:10:52 -0700 | [diff] [blame] | 113 | if (requestWriter.state != GRXWriterStateNotStarted) { |
Jorge Canizales | 597ef98 | 2015-07-31 23:31:56 -0700 | [diff] [blame] | 114 | [NSException raise:NSInvalidArgumentException |
| 115 | format:@"The requests writer can't be already started."]; |
Jorge Canizales | 6bbfcc3 | 2015-06-17 14:10:52 -0700 | [diff] [blame] | 116 | } |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 117 | if ((self = [super init])) { |
Jorge Canizales | 3a5253e | 2015-07-31 23:48:56 -0700 | [diff] [blame] | 118 | _wrappedCall = [[GRPCWrappedCall alloc] initWithHost:host path:path]; |
Jorge Canizales | 8c5318a | 2015-08-05 18:50:08 -0700 | [diff] [blame] | 119 | if (!_wrappedCall) { |
| 120 | return nil; |
| 121 | } |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 122 | |
| 123 | // Serial queue to invoke the non-reentrant methods of the grpc_call object. |
| 124 | _callQueue = dispatch_queue_create("org.grpc.call", NULL); |
| 125 | |
| 126 | _requestWriter = requestWriter; |
Jorge Canizales | 544963e | 2015-06-12 19:46:27 -0700 | [diff] [blame] | 127 | |
murgatroid99 | 84fa531 | 2015-08-28 10:55:55 -0700 | [diff] [blame] | 128 | _requestHeaders = [[GRPCRequestHeaders alloc] initWithCall:self]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 129 | } |
| 130 | return self; |
| 131 | } |
| 132 | |
Jorge Canizales | 544963e | 2015-06-12 19:46:27 -0700 | [diff] [blame] | 133 | #pragma mark Metadata |
| 134 | |
Jorge Canizales | 2f10127 | 2015-09-02 21:55:37 -0700 | [diff] [blame^] | 135 | - (id<GRPCRequestHeaders>)requestHeaders { |
Jorge Canizales | 6512d26 | 2015-08-12 17:33:23 -0700 | [diff] [blame] | 136 | return _requestHeaders; |
Jorge Canizales | 544963e | 2015-06-12 19:46:27 -0700 | [diff] [blame] | 137 | } |
| 138 | |
Jorge Canizales | 6512d26 | 2015-08-12 17:33:23 -0700 | [diff] [blame] | 139 | - (void)setRequestHeaders:(NSDictionary *)requestHeaders { |
murgatroid99 | 84fa531 | 2015-08-28 10:55:55 -0700 | [diff] [blame] | 140 | GRPCRequestHeaders *newHeaders = [[GRPCRequestHeaders alloc] initWithCall:self]; |
| 141 | for (id key in requestHeaders) { |
| 142 | newHeaders[key] = requestHeaders[key]; |
| 143 | } |
| 144 | _requestHeaders = newHeaders; |
Jorge Canizales | 544963e | 2015-06-12 19:46:27 -0700 | [diff] [blame] | 145 | } |
| 146 | |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 147 | #pragma mark Finish |
| 148 | |
| 149 | - (void)finishWithError:(NSError *)errorOrNil { |
Jorge Canizales | 6531b2b | 2015-07-18 00:19:14 -0700 | [diff] [blame] | 150 | // If the call isn't retained anywhere else, it can be deallocated now. |
Jorge Canizales | eb87b46 | 2015-08-08 16:16:43 -0700 | [diff] [blame] | 151 | _retainSelf = nil; |
Jorge Canizales | 6531b2b | 2015-07-18 00:19:14 -0700 | [diff] [blame] | 152 | |
| 153 | // If there were still request messages coming, stop them. |
Jorge Canizales | 238ad78 | 2015-08-07 23:11:29 -0700 | [diff] [blame] | 154 | @synchronized(_requestWriter) { |
| 155 | _requestWriter.state = GRXWriterStateFinished; |
Jorge Canizales | 238ad78 | 2015-08-07 23:11:29 -0700 | [diff] [blame] | 156 | } |
Jorge Canizales | 6531b2b | 2015-07-18 00:19:14 -0700 | [diff] [blame] | 157 | |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 158 | if (errorOrNil) { |
| 159 | [_responseWriteable cancelWithError:errorOrNil]; |
| 160 | } else { |
| 161 | [_responseWriteable enqueueSuccessfulCompletion]; |
| 162 | } |
| 163 | } |
| 164 | |
| 165 | - (void)cancelCall { |
| 166 | // Can be called from any thread, any number of times. |
murgatroid99 | b56609c | 2015-04-28 16:41:11 -0700 | [diff] [blame] | 167 | [_wrappedCall cancel]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 168 | } |
| 169 | |
| 170 | - (void)cancel { |
| 171 | [self finishWithError:[NSError errorWithDomain:kGRPCErrorDomain |
| 172 | code:GRPCErrorCodeCancelled |
| 173 | userInfo:nil]]; |
| 174 | [self cancelCall]; |
| 175 | } |
| 176 | |
| 177 | - (void)dealloc { |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 178 | __block GRPCWrappedCall *wrappedCall = _wrappedCall; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 179 | dispatch_async(_callQueue, ^{ |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 180 | wrappedCall = nil; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 181 | }); |
| 182 | } |
| 183 | |
| 184 | #pragma mark Read messages |
| 185 | |
| 186 | // Only called from the call queue. |
| 187 | // The handler will be called from the network queue. |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 188 | - (void)startReadWithHandler:(void(^)(grpc_byte_buffer *))handler { |
murgatroid99 | ca38ddb | 2015-04-29 13:16:42 -0700 | [diff] [blame] | 189 | // TODO(jcanizales): Add error handlers for async failures |
murgatroid99 | 54e93d4 | 2015-04-27 09:29:49 -0700 | [diff] [blame] | 190 | [_wrappedCall startBatchWithOperations:@[[[GRPCOpRecvMessage alloc] initWithHandler:handler]]]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | // Called initially from the network queue once response headers are received, |
| 194 | // then "recursively" from the responseWriteable queue after each response from the |
| 195 | // server has been written. |
| 196 | // If the call is currently paused, this is a noop. Restarting the call will invoke this |
| 197 | // method. |
| 198 | // TODO(jcanizales): Rename to readResponseIfNotPaused. |
| 199 | - (void)startNextRead { |
| 200 | if (self.state == GRXWriterStatePaused) { |
| 201 | return; |
| 202 | } |
| 203 | __weak GRPCCall *weakSelf = self; |
Jorge Canizales | 35f003b | 2015-07-17 21:14:36 -0700 | [diff] [blame] | 204 | __weak GRXConcurrentWriteable *weakWriteable = _responseWriteable; |
murgatroid99 | 69927d6 | 2015-04-24 13:32:48 -0700 | [diff] [blame] | 205 | |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 206 | dispatch_async(_callQueue, ^{ |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 207 | [weakSelf startReadWithHandler:^(grpc_byte_buffer *message) { |
| 208 | if (message == NULL) { |
murgatroid99 | b56609c | 2015-04-28 16:41:11 -0700 | [diff] [blame] | 209 | // No more messages from the server |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 210 | return; |
| 211 | } |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 212 | NSData *data = [NSData grpc_dataWithByteBuffer:message]; |
| 213 | grpc_byte_buffer_destroy(message); |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 214 | if (!data) { |
| 215 | // The app doesn't have enough memory to hold the server response. We |
| 216 | // don't want to throw, because the app shouldn't crash for a behavior |
| 217 | // that's on the hands of any server to have. Instead we finish and ask |
| 218 | // the server to cancel. |
| 219 | // |
| 220 | // TODO(jcanizales): No canonical code is appropriate for this situation |
| 221 | // (because it's just a client problem). Use another domain and an |
| 222 | // appropriately-documented code. |
| 223 | [weakSelf finishWithError:[NSError errorWithDomain:kGRPCErrorDomain |
| 224 | code:GRPCErrorCodeInternal |
| 225 | userInfo:nil]]; |
| 226 | [weakSelf cancelCall]; |
| 227 | return; |
| 228 | } |
Jorge Canizales | 4c6f778 | 2015-07-17 23:13:36 -0700 | [diff] [blame] | 229 | [weakWriteable enqueueValue:data completionHandler:^{ |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 230 | [weakSelf startNextRead]; |
| 231 | }]; |
| 232 | }]; |
| 233 | }); |
| 234 | } |
| 235 | |
| 236 | #pragma mark Send headers |
| 237 | |
Jorge Canizales | 2f10127 | 2015-09-02 21:55:37 -0700 | [diff] [blame^] | 238 | - (void)sendHeaders:(id<GRPCRequestHeaders>)headers { |
murgatroid99 | ca38ddb | 2015-04-29 13:16:42 -0700 | [diff] [blame] | 239 | // TODO(jcanizales): Add error handlers for async failures |
Jorge Canizales | 5c339d1 | 2015-09-02 17:41:43 -0700 | [diff] [blame] | 240 | [_wrappedCall startBatchWithOperations:@[[[GRPCOpSendMetadata alloc] initWithMetadata:headers |
| 241 | handler:nil]]]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 242 | } |
| 243 | |
| 244 | #pragma mark GRXWriteable implementation |
| 245 | |
| 246 | // Only called from the call queue. The error handler will be called from the |
| 247 | // network queue if the write didn't succeed. |
| 248 | - (void)writeMessage:(NSData *)message withErrorHandler:(void (^)())errorHandler { |
| 249 | |
| 250 | __weak GRPCCall *weakSelf = self; |
murgatroid99 | 54e93d4 | 2015-04-27 09:29:49 -0700 | [diff] [blame] | 251 | void(^resumingHandler)(void) = ^{ |
murgatroid99 | ca38ddb | 2015-04-29 13:16:42 -0700 | [diff] [blame] | 252 | // Resume the request writer. |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 253 | GRPCCall *strongSelf = weakSelf; |
| 254 | if (strongSelf) { |
Jorge Canizales | 578ab16 | 2015-08-08 17:11:43 -0700 | [diff] [blame] | 255 | @synchronized(strongSelf->_requestWriter) { |
Jorge Canizales | 238ad78 | 2015-08-07 23:11:29 -0700 | [diff] [blame] | 256 | strongSelf->_requestWriter.state = GRXWriterStateStarted; |
| 257 | } |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 258 | } |
| 259 | }; |
Jorge Canizales | 238ad78 | 2015-08-07 23:11:29 -0700 | [diff] [blame] | 260 | [_wrappedCall startBatchWithOperations:@[[[GRPCOpSendMessage alloc] initWithMessage:message |
| 261 | handler:resumingHandler]] |
| 262 | errorHandler:errorHandler]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 263 | } |
| 264 | |
Jorge Canizales | a90a9c3 | 2015-05-18 17:12:41 -0700 | [diff] [blame] | 265 | - (void)writeValue:(id)value { |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 266 | // TODO(jcanizales): Throw/assert if value isn't NSData. |
| 267 | |
| 268 | // Pause the input and only resume it when the C layer notifies us that writes |
| 269 | // can proceed. |
Jorge Canizales | 238ad78 | 2015-08-07 23:11:29 -0700 | [diff] [blame] | 270 | @synchronized(_requestWriter) { |
| 271 | _requestWriter.state = GRXWriterStatePaused; |
| 272 | } |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 273 | |
| 274 | __weak GRPCCall *weakSelf = self; |
| 275 | dispatch_async(_callQueue, ^{ |
| 276 | [weakSelf writeMessage:value withErrorHandler:^{ |
| 277 | [weakSelf finishWithError:[NSError errorWithDomain:kGRPCErrorDomain |
| 278 | code:GRPCErrorCodeInternal |
| 279 | userInfo:nil]]; |
| 280 | }]; |
| 281 | }); |
| 282 | } |
| 283 | |
| 284 | // Only called from the call queue. The error handler will be called from the |
| 285 | // network queue if the requests stream couldn't be closed successfully. |
| 286 | - (void)finishRequestWithErrorHandler:(void (^)())errorHandler { |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 287 | [_wrappedCall startBatchWithOperations:@[[[GRPCOpSendClose alloc] init]] |
| 288 | errorHandler:errorHandler]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 289 | } |
| 290 | |
Jorge Canizales | b2c300c | 2015-05-18 17:19:16 -0700 | [diff] [blame] | 291 | - (void)writesFinishedWithError:(NSError *)errorOrNil { |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 292 | if (errorOrNil) { |
| 293 | [self cancel]; |
| 294 | } else { |
| 295 | __weak GRPCCall *weakSelf = self; |
| 296 | dispatch_async(_callQueue, ^{ |
| 297 | [weakSelf finishRequestWithErrorHandler:^{ |
| 298 | [weakSelf finishWithError:[NSError errorWithDomain:kGRPCErrorDomain |
| 299 | code:GRPCErrorCodeInternal |
| 300 | userInfo:nil]]; |
| 301 | }]; |
| 302 | }); |
| 303 | } |
| 304 | } |
| 305 | |
| 306 | #pragma mark Invoke |
| 307 | |
| 308 | // Both handlers will eventually be called, from the network queue. Writes can start immediately |
| 309 | // after this. |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 310 | // The first one (headersHandler), when the response headers are received. |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 311 | // The second one (completionHandler), whenever the RPC finishes for any reason. |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 312 | - (void)invokeCallWithHeadersHandler:(void(^)(NSDictionary *))headersHandler |
Jorge Canizales | f3a4f2c | 2015-06-12 22:12:50 -0700 | [diff] [blame] | 313 | completionHandler:(void(^)(NSError *, NSDictionary *))completionHandler { |
murgatroid99 | ca38ddb | 2015-04-29 13:16:42 -0700 | [diff] [blame] | 314 | // TODO(jcanizales): Add error handlers for async failures |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 315 | [_wrappedCall startBatchWithOperations:@[[[GRPCOpRecvMetadata alloc] |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 316 | initWithHandler:headersHandler]]]; |
murgatroid99 | 6cc4680 | 2015-04-28 09:35:48 -0700 | [diff] [blame] | 317 | [_wrappedCall startBatchWithOperations:@[[[GRPCOpRecvStatus alloc] |
| 318 | initWithHandler:completionHandler]]]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 319 | } |
| 320 | |
| 321 | - (void)invokeCall { |
| 322 | __weak GRPCCall *weakSelf = self; |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 323 | [self invokeCallWithHeadersHandler:^(NSDictionary *headers) { |
Jorge Canizales | f3a4f2c | 2015-06-12 22:12:50 -0700 | [diff] [blame] | 324 | // Response headers received. |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 325 | GRPCCall *strongSelf = weakSelf; |
| 326 | if (strongSelf) { |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 327 | strongSelf.responseHeaders = headers; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 328 | [strongSelf startNextRead]; |
| 329 | } |
Jorge Canizales | f3a4f2c | 2015-06-12 22:12:50 -0700 | [diff] [blame] | 330 | } completionHandler:^(NSError *error, NSDictionary *trailers) { |
| 331 | GRPCCall *strongSelf = weakSelf; |
| 332 | if (strongSelf) { |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 333 | strongSelf.responseTrailers = trailers; |
Jorge Canizales | f3a4f2c | 2015-06-12 22:12:50 -0700 | [diff] [blame] | 334 | |
Jorge Canizales | c58a110 | 2015-06-15 19:03:41 -0700 | [diff] [blame] | 335 | if (error) { |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 336 | NSMutableDictionary *userInfo = [NSMutableDictionary dictionary]; |
| 337 | if (error.userInfo) { |
| 338 | [userInfo addEntriesFromDictionary:error.userInfo]; |
| 339 | } |
Jorge Canizales | 1ab2a71 | 2015-08-12 20:32:11 -0700 | [diff] [blame] | 340 | userInfo[kGRPCTrailersKey] = strongSelf.responseTrailers; |
Jorge Canizales | 0b34c89 | 2015-08-12 20:19:20 -0700 | [diff] [blame] | 341 | // TODO(jcanizales): The C gRPC library doesn't guarantee that the headers block will be |
| 342 | // called before this one, so an error might end up with trailers but no headers. We |
Jorge Canizales | 1ab2a71 | 2015-08-12 20:32:11 -0700 | [diff] [blame] | 343 | // shouldn't call finishWithError until ater both blocks are called. It is also when this is |
| 344 | // done that we can provide a merged view of response headers and trailers in a thread-safe |
| 345 | // way. |
| 346 | if (strongSelf.responseHeaders) { |
| 347 | userInfo[kGRPCHeadersKey] = strongSelf.responseHeaders; |
| 348 | } |
Jorge Canizales | c58a110 | 2015-06-15 19:03:41 -0700 | [diff] [blame] | 349 | error = [NSError errorWithDomain:error.domain code:error.code userInfo:userInfo]; |
| 350 | } |
Jorge Canizales | f3a4f2c | 2015-06-12 22:12:50 -0700 | [diff] [blame] | 351 | [strongSelf finishWithError:error]; |
| 352 | } |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 353 | }]; |
| 354 | // Now that the RPC has been initiated, request writes can start. |
Jorge Canizales | 238ad78 | 2015-08-07 23:11:29 -0700 | [diff] [blame] | 355 | @synchronized(_requestWriter) { |
| 356 | [_requestWriter startWithWriteable:self]; |
| 357 | } |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 358 | } |
| 359 | |
| 360 | #pragma mark GRXWriter implementation |
| 361 | |
| 362 | - (void)startWithWriteable:(id<GRXWriteable>)writeable { |
Jorge Canizales | 6531b2b | 2015-07-18 00:19:14 -0700 | [diff] [blame] | 363 | // Create a retain cycle so that this instance lives until the RPC finishes (or is cancelled). |
| 364 | // This makes RPCs in which the call isn't externally retained possible (as long as it is started |
| 365 | // before being autoreleased). |
| 366 | // Care is taken not to retain self strongly in any of the blocks used in this implementation, so |
| 367 | // that the life of the instance is determined by this retain cycle. |
Jorge Canizales | eb87b46 | 2015-08-08 16:16:43 -0700 | [diff] [blame] | 368 | _retainSelf = self; |
Jorge Canizales | 6531b2b | 2015-07-18 00:19:14 -0700 | [diff] [blame] | 369 | |
| 370 | _responseWriteable = [[GRXConcurrentWriteable alloc] initWithWriteable:writeable]; |
Jorge Canizales | 6512d26 | 2015-08-12 17:33:23 -0700 | [diff] [blame] | 371 | [self sendHeaders:_requestHeaders]; |
Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 372 | [self invokeCall]; |
| 373 | } |
| 374 | |
| 375 | - (void)setState:(GRXWriterState)newState { |
| 376 | // Manual transitions are only allowed from the started or paused states. |
| 377 | if (_state == GRXWriterStateNotStarted || _state == GRXWriterStateFinished) { |
| 378 | return; |
| 379 | } |
| 380 | |
| 381 | switch (newState) { |
| 382 | case GRXWriterStateFinished: |
| 383 | _state = newState; |
| 384 | // Per GRXWriter's contract, setting the state to Finished manually |
| 385 | // means one doesn't wish the writeable to be messaged anymore. |
| 386 | [_responseWriteable cancelSilently]; |
| 387 | _responseWriteable = nil; |
| 388 | return; |
| 389 | case GRXWriterStatePaused: |
| 390 | _state = newState; |
| 391 | return; |
| 392 | case GRXWriterStateStarted: |
| 393 | if (_state == GRXWriterStatePaused) { |
| 394 | _state = newState; |
| 395 | [self startNextRead]; |
| 396 | } |
| 397 | return; |
| 398 | case GRXWriterStateNotStarted: |
| 399 | return; |
| 400 | } |
| 401 | } |
| 402 | @end |