| commit | author | age | ||
| a6c014 | 1 | /** |
| L | 2 | Copyright 2018 Google Inc. All rights reserved. |
| 3 | ||
| 4 | Licensed under the Apache License, Version 2.0 (the "License"); | |
| 5 | you may not use this file except in compliance with the License. | |
| 6 | You may obtain a copy of the License at: | |
| 7 | ||
| 8 | http://www.apache.org/licenses/LICENSE-2.0 | |
| 9 | ||
| 10 | Unless required by applicable law or agreed to in writing, software | |
| 11 | distributed under the License is distributed on an "AS IS" BASIS, | |
| 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 13 | See the License for the specific language governing permissions and | |
| 14 | limitations under the License. | |
| 15 | */ | |
| 16 | ||
| 17 | #import "FBLPromise.h" | |
| 18 | ||
| 19 | NS_ASSUME_NONNULL_BEGIN | |
| 20 | ||
| 21 | @interface FBLPromise<Value>(RaceAdditions) | |
| 22 | ||
| 23 | /** | |
| 24 | Wait until any of the given promises are fulfilled. | |
| 25 | If one of the promises is rejected, then the returned promise is rejected with same error. | |
| 26 | If any other arbitrary value or `NSError` appears in the array instead of `FBLPromise`, | |
| 27 | it's implicitly considered a pre-fulfilled or pre-rejected `FBLPromise` correspondingly. | |
| 28 | ||
| 29 | @param promises Promises to wait for. | |
| 30 | @return A new pending promise to be resolved with the same resolution as the first promise, among | |
| 31 | the given ones, which was resolved. | |
| 32 | */ | |
| 33 | + (instancetype)race:(NSArray *)promises NS_SWIFT_UNAVAILABLE(""); | |
| 34 | ||
| 35 | /** | |
| 36 | Wait until any of the given promises are fulfilled. | |
| 37 | If one of the promises is rejected, then the returned promise is rejected with same error. | |
| 38 | If any other arbitrary value or `NSError` appears in the array instead of `FBLPromise`, | |
| 39 | it's implicitly considered a pre-fulfilled or pre-rejected `FBLPromise` correspondingly. | |
| 40 | ||
| 41 | @param queue A queue to dispatch on. | |
| 42 | @param promises Promises to wait for. | |
| 43 | @return A new pending promise to be resolved with the same resolution as the first promise, among | |
| 44 | the given ones, which was resolved. | |
| 45 | */ | |
| 46 | + (instancetype)onQueue:(dispatch_queue_t)queue race:(NSArray *)promises NS_REFINED_FOR_SWIFT; | |
| 47 | ||
| 48 | @end | |
| 49 | ||
| 50 | /** | |
| 51 | Convenience dot-syntax wrappers for `FBLPromise` `race` operators. | |
| 52 | Usage: FBLPromise.race(@[ ... ]) | |
| 53 | */ | |
| 54 | @interface FBLPromise<Value>(DotSyntax_RaceAdditions) | |
| 55 | ||
| 56 | + (FBLPromise * (^)(NSArray *))race FBL_PROMISES_DOT_SYNTAX NS_SWIFT_UNAVAILABLE(""); | |
| 57 | + (FBLPromise * (^)(dispatch_queue_t, NSArray *))raceOn FBL_PROMISES_DOT_SYNTAX | |
| 58 | NS_SWIFT_UNAVAILABLE(""); | |
| 59 | ||
| 60 | @end | |
| 61 | ||
| 62 | NS_ASSUME_NONNULL_END | |
