如何使用来自 ObjC class 的 std::function 回调在 C++ 中进行异步工作?
How to do async work in C++ with std::function callback from an ObjC class?
大图
我有一个 C++ 库,可以执行包括网络在内的异步工作。它有一个达尔文特定的后端,使用 Grand Central Dispatch 的 C API 将工作委托给其他线程。现在,我想通过 ObjC++ 的薄层,从用 Swift 编写的新 iOS 应用程序中使用该库。
我在 OS X 10.10 上使用 Xcode 6.3.2。
在这个最小的示例中,我重新创建了上述架构。问题是启动异步操作的 ObjC class 实例在某种程度上 "broken" 当操作 returns 通过 std::function 回调时。如果 std::function 被声明为 [&]
而不是 [=]
,则仅 会发生这种情况。我不能使用后者,因为 "real" C++ 代码不支持它。
调用 ObjC++ 的 Swift 代码如下所示:
class MyViewController : UIViewController {
var test = ObjectiveTest()
override func viewDidAppear(animated: Bool) {
test.testAsyncWork("some data", withHandler: { (result: Int32) -> Void in
println("Work result: \(result)")
})
}
}
如果我注释掉该代码,视图控制器会显示并保持可见,因此它不应终止 ObjectiveTest 实例。那就是ObjC++胶层:
@interface ObjectiveTest () {
__block Test *test;
__block int _a;
}
@end
@implementation ObjectiveTest
- (id)init
{
self = [super init];
if (self) {
test = new Test();
_a = 42;
if (!test)
self = nil;
}
return self;
}
- (void)deinit
{
delete test;
}
- (void)testAsyncWork:(NSString *)someData withHandler:(WorkBlock)handler
{
_a++;
NSLog(@"_a = %i", _a); // valid
NSLog(@"handler = %@", handler); // valid
test->testAsyncWork(someData.UTF8String, [&](int result) {
_a++;
NSLog(@"result = %i", result); // Expected: "result = 666" - valid
NSLog(@"_a = %i", _a); // Expected: "_a = 44" - invalid
NSLog(@"handler = %@", handler); // invalid, crashes here
});
}
@end
最后,执行 "work":
的 C++ 方法
void Test::testAsyncWork(std::string someData, std::function<Handler> handler) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
printf("Data received: %s, calling handler on other thread\n", someData.c_str());
sleep(1); // This is hard work!
dispatch_async(dispatch_get_main_queue(), ^{
printf("Hello, main thread here, calling back now!\n");
handler(666); // into ObjectiveTest
});
});
}
观察
正如我所说,如果我对 std::function 使用 [=]
,这不会中断。
ObjectiveTest 的 ivar _a
似乎在回调函数中有随机值,尽管它是用 __block
声明的。当试图访问 (print/call) 块 handler
回调到 Swift 代码时程序崩溃。 Xcode 显示如下:
handler WorkBlock & error: summary string parsing error 0xbffa50cc
&handler __block_literal_generic * 0x7c000000 0x0ae08500
__isa void * NULL 0x00000000
__flags int 0 0
__reserved int 2080876705 2080876705
__FuncPtr void (*)(int) 0x7c000000 0x7c000000
__descriptor __block_descriptor * 0x7c085b10 0x7c085b10
从这里,我得到的印象是 ObjectiveTest 实例在过程中的某处中断,但由于它保存在 MyViewController 中,我看不出这是怎么发生的。我是不是漏掉了什么?
[&]
通过引用捕获变量。抓取的引用,如果原始变量在任务完成前过期,就会悬空。
由于异步调用可能旨在异步完成1,您基本上可以保证悬挂引用。
进行异步调用时,您几乎总是希望按值捕获。您甚至可能想要 明确地 列出您正在捕获的内容,以便您可以了解您正在引入哪些依赖项。 (没有 hidden/implicit 依赖项的多线程代码已经够难了)
[&]
捕获的唯一有效用途是创建一个 "visitor" 类型的对象以传递给将使用 lambda 的函数,然后丢弃它及其所有副本,然后它 returns。除此之外,您应该按价值捕获任何内容,或者非常仔细地选择您通过引用捕获的内容并证明涵盖了生命周期问题。
1 可能想要 [&]
的异步方法的示例是 "run on UI pump thread" 异步调用,您希望在其中暂停工作线程直到结果从 UI 线程返回。在那里,您会 [&]
,并在离开当前范围之前阻止返回的 std::future
(或等效)。
大图
我有一个 C++ 库,可以执行包括网络在内的异步工作。它有一个达尔文特定的后端,使用 Grand Central Dispatch 的 C API 将工作委托给其他线程。现在,我想通过 ObjC++ 的薄层,从用 Swift 编写的新 iOS 应用程序中使用该库。
我在 OS X 10.10 上使用 Xcode 6.3.2。
在这个最小的示例中,我重新创建了上述架构。问题是启动异步操作的 ObjC class 实例在某种程度上 "broken" 当操作 returns 通过 std::function 回调时。如果 std::function 被声明为 [&]
而不是 [=]
,则仅 会发生这种情况。我不能使用后者,因为 "real" C++ 代码不支持它。
调用 ObjC++ 的 Swift 代码如下所示:
class MyViewController : UIViewController {
var test = ObjectiveTest()
override func viewDidAppear(animated: Bool) {
test.testAsyncWork("some data", withHandler: { (result: Int32) -> Void in
println("Work result: \(result)")
})
}
}
如果我注释掉该代码,视图控制器会显示并保持可见,因此它不应终止 ObjectiveTest 实例。那就是ObjC++胶层:
@interface ObjectiveTest () {
__block Test *test;
__block int _a;
}
@end
@implementation ObjectiveTest
- (id)init
{
self = [super init];
if (self) {
test = new Test();
_a = 42;
if (!test)
self = nil;
}
return self;
}
- (void)deinit
{
delete test;
}
- (void)testAsyncWork:(NSString *)someData withHandler:(WorkBlock)handler
{
_a++;
NSLog(@"_a = %i", _a); // valid
NSLog(@"handler = %@", handler); // valid
test->testAsyncWork(someData.UTF8String, [&](int result) {
_a++;
NSLog(@"result = %i", result); // Expected: "result = 666" - valid
NSLog(@"_a = %i", _a); // Expected: "_a = 44" - invalid
NSLog(@"handler = %@", handler); // invalid, crashes here
});
}
@end
最后,执行 "work":
的 C++ 方法void Test::testAsyncWork(std::string someData, std::function<Handler> handler) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
printf("Data received: %s, calling handler on other thread\n", someData.c_str());
sleep(1); // This is hard work!
dispatch_async(dispatch_get_main_queue(), ^{
printf("Hello, main thread here, calling back now!\n");
handler(666); // into ObjectiveTest
});
});
}
观察
正如我所说,如果我对 std::function 使用 [=]
,这不会中断。
ObjectiveTest 的 ivar _a
似乎在回调函数中有随机值,尽管它是用 __block
声明的。当试图访问 (print/call) 块 handler
回调到 Swift 代码时程序崩溃。 Xcode 显示如下:
handler WorkBlock & error: summary string parsing error 0xbffa50cc
&handler __block_literal_generic * 0x7c000000 0x0ae08500
__isa void * NULL 0x00000000
__flags int 0 0
__reserved int 2080876705 2080876705
__FuncPtr void (*)(int) 0x7c000000 0x7c000000
__descriptor __block_descriptor * 0x7c085b10 0x7c085b10
从这里,我得到的印象是 ObjectiveTest 实例在过程中的某处中断,但由于它保存在 MyViewController 中,我看不出这是怎么发生的。我是不是漏掉了什么?
[&]
通过引用捕获变量。抓取的引用,如果原始变量在任务完成前过期,就会悬空。
由于异步调用可能旨在异步完成1,您基本上可以保证悬挂引用。
进行异步调用时,您几乎总是希望按值捕获。您甚至可能想要 明确地 列出您正在捕获的内容,以便您可以了解您正在引入哪些依赖项。 (没有 hidden/implicit 依赖项的多线程代码已经够难了)
[&]
捕获的唯一有效用途是创建一个 "visitor" 类型的对象以传递给将使用 lambda 的函数,然后丢弃它及其所有副本,然后它 returns。除此之外,您应该按价值捕获任何内容,或者非常仔细地选择您通过引用捕获的内容并证明涵盖了生命周期问题。
1 可能想要 [&]
的异步方法的示例是 "run on UI pump thread" 异步调用,您希望在其中暂停工作线程直到结果从 UI 线程返回。在那里,您会 [&]
,并在离开当前范围之前阻止返回的 std::future
(或等效)。