In my app I have a function that makes an NSRURLSession and sends out an NSURLRequest using
sesh.dataTaskWithRequest(req, completionHandler: {(data, response, error)
In the completion block for this task, I need to do some computation that adds a UIImage to the calling viewcontroller. I have a func called
func displayQRCode(receiveAddr, withAmountInBTC:amountBTC)
that does the UIImage-adding computation. If I try to run the view-adding code inside of the completion block, Xcode throws an error saying that I can't use the layout engine while in a background process. So I found some code on SO that tries to queue a method on the main thread:
let time = dispatch_time(DISPATCH_TIME_NOW, Int64(0.0 * Double(NSEC_PER_MSEC)))
dispatch_after(time, dispatch_get_main_queue(), {
let returned = UIApplication.sharedApplication().sendAction("displayQRCode:", to: self.delegate, from: self, forEvent: nil)
})
However, I don't know how to add the parameters "receiveAddr" and "amountBTC" to this function call. How would I do this, or can someone suggest an optimal way for adding a method call to the application's main queue?
Modern versions of Swift use DispatchQueue.main.async
to dispatch to the main thread:
DispatchQueue.main.async {
// your code here
}
To dispatch after on the main queue, use:
DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {
// your code here
}
Older versions of Swift used:
dispatch_async(dispatch_get_main_queue(), {
let delegateObj = UIApplication.sharedApplication().delegate as YourAppDelegateClass
delegateObj.addUIImage("yourstring")
})
Swift 3+ & Swift 4 version:
DispatchQueue.main.async {
print("Hello")
}
Swift 3 and Xcode 9.2:
dispatch_async_on_main_queue {
print("Hello")
}
Swift 2
Using Trailing Closures this becomes:
dispatch_async(dispatch_get_main_queue()) {
self.tableView.reloadData()
}
Trailing Closures is Swift syntactic sugar that enables defining the closure outside of the function parameter scope. For more information see Trailing Closures in Swift 2.2 Programming Language Guide.
In dispatch_async case the API is func dispatch_async(queue: dispatch_queue_t, _ block: dispatch_block_t)
since dispatch_block_t
is type alias for () -> Void
- A closure that receives 0 parameters and does not have a return value, and block being the last parameter of the function we can define the closure in the outer scope of dispatch_async
.
Reload collectionView on Main Thread
DispatchQueue.main.async {
self.collectionView.reloadData()
}
Here's the nicer (IMO) Swifty/Cocoa style syntax to achieve the same result as the other answers:
NSOperationQueue.mainQueue().addOperationWithBlock({
// Your code here
})
Or you could grab the popular Async Swift library for even less code and more functionality:
Async.main {
// Your code here
}
OperationQueue.main.addOperation({ }
The proper way to do this is to use dispatch_async in the main_queue, as I did in the following code
dispatch_async(dispatch_get_main_queue(), {
(self.delegate as TBGQRCodeViewController).displayQRCode(receiveAddr, withAmountInBTC:amountBTC)
})
Here's a nice little global function you can add for a nicer syntax:
func dispatch_on_main(block: dispatch_block_t) {
dispatch_async(dispatch_get_main_queue(), block)
}
And usage
dispatch_on_main {
// Do some UI stuff
}
//Perform some task and update UI immediately.
DispatchQueue.global(qos: .userInitiated).async {
// Call your function here
DispatchQueue.main.async {
// Update UI
self.tableView.reloadData()
}
}
//To call or execute function after some time
DispatchQueue.main.asyncAfter(deadline: .now() + 5.0) {
//Here call your function
}
//If you want to do changes in UI use this
DispatchQueue.main.async(execute: {
//Update UI
self.tableView.reloadData()
})
Don't forget to weakify self if you are using self inside of the closure.
dispatch_async(dispatch_get_main_queue(),{ [weak self] () -> () in
if let strongSelf = self {
self?.doSomething()
}
})
you can switch to the main thread using
DispatchQueue.main.async {
// UI Code Goes Here
}
you can also write more reusable and readable code my writing you custom protocol by the following POP
protocol MainThreadRunAble : AnyObject {}
implement protocol using extension
extension MainThreadRunAble {
func runOnMain(code : @escaping()->()) {
DispatchQueue.main.async {
code()
}
}
func runOnMain(withDelay delay : Float ,code : @escaping()->()){
DispatchQueue.main.asyncAfter(deadline: .now() + delay) {
code()
}
}}
conform your class to a protocol where you want to run on the main thread
class YourClass : BaseClass,MainThreadRunAble{}
then call one of the method based on your requirement
runOnMain {
//update on main
}
runOnMain(withDelay: 1) {
//update on main
}
if you are using any architecture and just want to make sure, only viewcontroller has access to this piece of code to run on the main thread, then implement your extension
extension UIViewController {
func runOnMain(code : @escaping()->()) {
DispatchQueue.main.async {
code()
}
}
func runOnMain(withDelay delay : Float ,code : @escaping()->()){
DispatchQueue.main.asyncAfter(deadline: .now() + delay) {
code()
}
}}
For modern Swift code (Swift 5.5+ and iOS 13+) Apple suggests main threading tasks to the Main Actor rather than GCD for cleaner, performant and safer code.
I've outlined 4 ways to dispatch to the main thread using actors in detail here.
The simplest possible would be to annotate the method in question with the @MainActor
property wrapper.
@MainActor func callFunctionOnMainThread(paramOne: Int, paramTwo: String) {
// We can now access parameters on the main thread
}
We make use of Structured Concurrency i.e. async/await
:
await callFunctionOnMainThread(paramOne: 2, paramTwo: "Two")
Success story sharing