RTCThreadUtils.kt
3.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
* Copyright 2023-2024 LiveKit, Inc.
*
* 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.
*/
package io.livekit.android.webrtc.peerconnection
import androidx.annotation.VisibleForTesting
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.asCoroutineDispatcher
import kotlinx.coroutines.async
import kotlinx.coroutines.coroutineScope
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors
import java.util.concurrent.ThreadFactory
import java.util.concurrent.atomic.AtomicInteger
// Executor thread is started once and is used for all
// peer connection API calls to ensure new peer connection factory is
// created on the same thread as previously destroyed factory.
private const val EXECUTOR_THREADNAME_PREFIX = "LK_RTC_THREAD"
private val threadFactory = object : ThreadFactory {
private val idGenerator = AtomicInteger(0)
override fun newThread(r: Runnable): Thread {
val thread = Thread(r)
thread.name = EXECUTOR_THREADNAME_PREFIX + "_" + idGenerator.incrementAndGet()
return thread
}
}
// var only for testing purposes, do not alter in production!
private var executor = Executors.newSingleThreadExecutor(threadFactory)
private var rtcDispatcher: CoroutineDispatcher = executor.asCoroutineDispatcher()
/**
* Overrides how RTC thread calls are executed and dispatched.
*
* This should absolutely not be used in production environments and is
* only to be used for testing.
*/
@VisibleForTesting
fun overrideExecutorAndDispatcher(executorService: ExecutorService, dispatcher: CoroutineDispatcher) {
executor = executorService
rtcDispatcher = dispatcher
}
/**
* Execute [action] on the RTC thread. The PeerConnection API
* is generally not thread safe, so all actions relating to
* peer connection objects should go through the RTC thread.
*
* @suppress
*/
internal fun <T> executeOnRTCThread(action: () -> T) {
if (Thread.currentThread().name.startsWith(EXECUTOR_THREADNAME_PREFIX)) {
action()
} else {
executor.submit(action)
}
}
/**
* Execute [action] synchronously on the RTC thread. The PeerConnection API
* is generally not thread safe, so all actions relating to
* peer connection objects should go through the RTC thread.
*
* @suppress
*/
internal fun <T> executeBlockingOnRTCThread(action: () -> T): T {
return if (Thread.currentThread().name.startsWith(EXECUTOR_THREADNAME_PREFIX)) {
action()
} else {
executor.submit(action).get()
}
}
/**
* Launch [action] synchronously on the RTC thread. The PeerConnection API
* is generally not thread safe, so all actions relating to
* peer connection objects should go through the RTC thread.
*/
internal suspend fun <T> launchBlockingOnRTCThread(action: suspend CoroutineScope.() -> T): T = coroutineScope {
return@coroutineScope if (Thread.currentThread().name.startsWith(EXECUTOR_THREADNAME_PREFIX)) {
this.action()
} else {
async(rtcDispatcher) {
this.action()
}.await()
}
}