RLMAsyncTask_Private.h 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. ////////////////////////////////////////////////////////////////////////////
  2. //
  3. // Copyright 2023 Realm Inc.
  4. //
  5. // Licensed under the Apache License, Version 2.0 (the "License");
  6. // you may not use this file except in compliance with the License.
  7. // You may obtain a copy of the License at
  8. //
  9. // http://www.apache.org/licenses/LICENSE-2.0
  10. //
  11. // Unless required by applicable law or agreed to in writing, software
  12. // distributed under the License is distributed on an "AS IS" BASIS,
  13. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. // See the License for the specific language governing permissions and
  15. // limitations under the License.
  16. //
  17. ////////////////////////////////////////////////////////////////////////////
  18. #import <Realm/RLMAsyncTask.h>
  19. #import "RLMRealm_Private.h"
  20. RLM_HEADER_AUDIT_BEGIN(nullability)
  21. @interface RLMAsyncOpenTask ()
  22. @property (nonatomic, nullable) RLMRealm *localRealm;
  23. - (instancetype)initWithConfiguration:(RLMRealmConfiguration *)configuration
  24. confinedTo:(RLMScheduler *)confinement
  25. download:(bool)waitForDownloadCompletion
  26. completion:(RLMAsyncOpenRealmCallback)completion
  27. __attribute__((objc_direct));
  28. - (instancetype)initWithConfiguration:(RLMRealmConfiguration *)configuration
  29. confinedTo:(RLMScheduler *)confinement
  30. download:(bool)waitForDownloadCompletion;
  31. - (void)waitWithCompletion:(void (^)(NSError *_Nullable))completion;
  32. - (void)waitForOpen:(RLMAsyncOpenRealmCallback)completion __attribute__((objc_direct));
  33. @end
  34. // A cancellable task for waiting for downloads on an already-open Realm.
  35. RLM_SWIFT_SENDABLE
  36. @interface RLMAsyncDownloadTask : NSObject
  37. - (instancetype)initWithRealm:(RLMRealm *)realm;
  38. - (void)cancel;
  39. - (void)waitWithCompletion:(void (^)(NSError *_Nullable))completion;
  40. @end
  41. // A cancellable task for beginning an async write
  42. RLM_SWIFT_SENDABLE
  43. @interface RLMAsyncWriteTask : NSObject
  44. // Must only be called from within the Actor
  45. - (instancetype)initWithRealm:(RLMRealm *)realm;
  46. - (void)setTransactionId:(RLMAsyncTransactionId)transactionID;
  47. - (void)complete:(bool)cancel;
  48. // Can be called from any thread
  49. - (void)wait:(void (^)(void))completion;
  50. @end
  51. typedef void (^RLMAsyncRefreshCompletion)(bool);
  52. // A cancellable task for refreshing a Realm
  53. RLM_SWIFT_SENDABLE
  54. @interface RLMAsyncRefreshTask : NSObject
  55. - (void)complete:(bool)didRefresh;
  56. - (void)wait:(RLMAsyncRefreshCompletion)completion;
  57. + (RLMAsyncRefreshTask *)completedRefresh;
  58. @end
  59. RLM_HEADER_AUDIT_END(nullability)