xref: /aosp_15_r20/external/webrtc/sdk/objc/helpers/RTCDispatcher.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
2  *  Copyright 2015 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #import <Foundation/Foundation.h>
12 
13 #import "RTCMacros.h"
14 
15 typedef NS_ENUM(NSInteger, RTCDispatcherQueueType) {
16   // Main dispatcher queue.
17   RTCDispatcherTypeMain,
18   // Used for starting/stopping AVCaptureSession, and assigning
19   // capture session to AVCaptureVideoPreviewLayer.
20   RTCDispatcherTypeCaptureSession,
21   // Used for operations on AVAudioSession.
22   RTCDispatcherTypeAudioSession,
23   // Used for operations on NWPathMonitor.
24   RTCDispatcherTypeNetworkMonitor,
25 };
26 
27 /** Dispatcher that asynchronously dispatches blocks to a specific
28  *  shared dispatch queue.
29  */
30 RTC_OBJC_EXPORT
31 @interface RTC_OBJC_TYPE (RTCDispatcher) : NSObject
32 
33 - (instancetype)init NS_UNAVAILABLE;
34 
35 /** Dispatch the block asynchronously on the queue for dispatchType.
36  *  @param dispatchType The queue type to dispatch on.
37  *  @param block The block to dispatch asynchronously.
38  */
39 + (void)dispatchAsyncOnType:(RTCDispatcherQueueType)dispatchType block:(dispatch_block_t)block;
40 
41 /** Returns YES if run on queue for the dispatchType otherwise NO.
42  *  Useful for asserting that a method is run on a correct queue.
43  */
44 + (BOOL)isOnQueueForType:(RTCDispatcherQueueType)dispatchType;
45 
46 @end
47