-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Darwin: Deprecate MTRAsyncCallbackQueue and clone into MTRAsyncWorkQu…
…eue (#29356) MTRAsyncCallbackQueue was accidentally made part of the public API, which is now constraining our ability to refactor its API. This change "renames" the class to MTRAsyncWorkQueue (and similar renames for related types), but leaves the existing MTRAsyncCallbackQueue class in place. (More precisely, only the parts of it that were public are retained.) Also disable TAPI for Debug builds so we can easily unit-test internal parts of the framework.
- Loading branch information
1 parent
d64fd13
commit bfa9b4c
Showing
14 changed files
with
1,372 additions
and
792 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /** | ||
| * | ||
| * Copyright (c) 2022 Project CHIP Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #import "MTRDefines_Internal.h" | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| @class MTRAsyncWorkItem; | ||
|
|
||
| typedef void (^MTRAsyncWorkReadyHandler)(id context, NSUInteger retryCount); | ||
|
|
||
| // MTRAsyncWorkQueue high level description | ||
| // The MTRAsyncWorkQueue was made to call one readyHandler | ||
| // block at a time asynchronously, and the readyHandler is | ||
| // expected to start/schedule a task. When the task finishes | ||
| // asynchronously in the future (at any time, from any queue | ||
| // or thread), it is expected to ask the workItem object to | ||
| // either endWork or retryWork. | ||
|
|
||
| // Sequence of steps when queuing a work item: | ||
| // - Create MTRAsyncWorkItem object | ||
| // - Create ready handler block (MTRAsyncWorkReadyHandler) | ||
| // - block is called when it's the WorkItem's turn to do work | ||
| // - its body is to perform a task that is expected to end asynchronously in the future | ||
| // - at the end of work, call on the work item object: | ||
| // - endWork for success or failure | ||
| // - retryWork for temporary failures | ||
| // - Set the readyHandler block on the WorkItem object | ||
| // - Call enqueueWorkItem on a MTRAsyncWorkQueue | ||
|
|
||
| // A serial one-at-a-time queue for performing work items | ||
| MTR_TESTABLE | ||
| @interface MTRAsyncWorkQueue : NSObject | ||
| - (instancetype)init NS_UNAVAILABLE; | ||
| + (instancetype)new NS_UNAVAILABLE; | ||
|
|
||
| // The context object is only held and passed back as a reference and is opaque to the work queue | ||
| - (instancetype)initWithContext:(id _Nullable)context queue:(dispatch_queue_t)queue; | ||
|
|
||
| // Called by the work queue owner to clean up and cancel work items | ||
| - (void)invalidate; | ||
|
|
||
| // Work items may be enqueued from any queue or thread | ||
| // Note: Once a work item is enqueued, its handlers cannot be modified | ||
| - (void)enqueueWorkItem:(MTRAsyncWorkItem *)item; | ||
| @end | ||
|
|
||
| // An item in the work queue | ||
| MTR_TESTABLE | ||
| @interface MTRAsyncWorkItem : NSObject | ||
| - (instancetype)init NS_UNAVAILABLE; | ||
| + (instancetype)new NS_UNAVAILABLE; | ||
|
|
||
| // Both readyHandler and cancelHander will be called on the queue given to initWithQueue | ||
| - (instancetype)initWithQueue:(dispatch_queue_t)queue; | ||
| @property (nonatomic, strong) MTRAsyncWorkReadyHandler readyHandler; | ||
| @property (nonatomic, strong) dispatch_block_t cancelHandler; | ||
|
|
||
| // Called by the creater of the work item when async work is done and should | ||
| // be removed from the queue. The work queue will run the next work item. | ||
| // Note: This must only be called from within the readyHandler | ||
| - (void)endWork; | ||
|
|
||
| // Called by the creater of the work item when async work should be retried. | ||
| // The work queue will call this workItem's readyHandler again. | ||
| // Note: This must only be called from within the readyHandler | ||
| - (void)retryWork; | ||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
Oops, something went wrong.