托管C++随笔二：回调函数

在C++程序里，经常会碰到通过回调函数来返回数据的情况，那么在托管C++里如何实现回调函数呢？其实也不难，只要理解回调函数，不过是一个函数指针而已，就简单了。

在托管代码里，是通过委托（delegate）来描述函数指针的，只不过这里需要注意.net的垃圾回收机制，要防止定义的委托被gc回收，否则回调函数一旦被回收或移动，那么委托指向的地址就是一个无效地址，此时C++代码里的回调调用就会失败，导致程序崩溃。

1，在非托管代码里定义回调函数

typedef void(__stdcall *pMyCallBack)(void* pData, int nDataSize);

pData的内容是一些字节流，nDataSize，是这个数据的长度，字节单位。

2，在托管代码里定义委托

[UnmanagedFunctionPointer(CallingConvention.StdCall)]
public delegate void MyCallBack(System::IntPtr pData, int nDataSize);

3，在托管C++代码里定义函数接口，用于传入回调函数

void Fun(MyCallBack^ audioCallBack);

上面定义了一个函数，接收一个回调函数作为参数，当托管C++代码编译为dll，被引入到.net程序中时，在那边看到的形式就是这样的：

public void Fun(MyCallBack audioCallBack)

这个时候，其实有两种选择来防止gc回收，一种就是在托管C++代码里做，另一个就是在.net代码里做。两种都是一样的，但是如果你想写一个dll给别人调用，那么你负责完成这件事还是好一些，下面我会分别讲解两种方式怎么做。

• 托管C++里的实现方式

// 首先得定义一个类变量，用于存储回调函数的指针句柄

GCHandle^ m_gcAudio;

// 在某个初始化函数，接本文章例子，就是Fun函数里，需要创建这个句柄，用于保护你的回调函数不被gc回收

m_gcAudio = GCHandle::Alloc(audioCallBack);

// 由于传入的是一个delegate委托对象，我们还需要做一些转换，将其转换为c++函数指针

		IntPtr audioDelegatePointer = Marshal::GetFunctionPointerForDelegate(audioCallBack);
		pMyCallBack pTmpAudioCallBackCpp = static_cast<pMyCallBack>(audioDelegatePointer.ToPointer());

// 这个时候，pTmpAudioCallBackCpp就是指向回调函数的指针，可以用于回调使用了，这个就不需要再详解了

// 当程序要结束时，你需要负责回收创建的 GCHandle ，释放资源，比如在某个Cleanup函数，或者析构函数里，总之你如果不需要再使用回调了，就可以释放这个资源了

		if (nullptr != m_gcAudio && m_gcAudio->IsAllocated)
		{
			m_gcAudio->Free();
			m_gcAudio = nullptr;
		}

• .net 代码里的实现方式

// .net 里的防止 gc 回收的做法，和上面类似，大家只需要搞清楚哪些情况下会gc回收的就可以了

// 定义一个GCHandle 用于保护委托对象，即回调函数
private GCHandle _gcHandleForCB;
// 定义一个委托变量，接本章的例子，就是MyCallBack
private MyCallBack _myCallback;
// 声明委托实现函数
public void MyCallbackImpl(IntPtr pData, int nDataSize)
{
    // 在这里处理回调的数据
}

// 初始化
_myCallback = new MyCallBack(MyCallbackImpl);
_gcHandleForCB = GCHandle.Alloc(_myCallback);

// 当不再使用回调的时候，就可以释放资源了
if (_gcHandleForCB.IsAllocated)
{
    _gcHandleForCB.Free();
}

上述.net的方式，如果还存在需要传入一个用户自定义数据，例如this的话，那么可以把this也作为被保护对象，放入GCHandle。

对于什么类型的数据需要保护，大家也可以思考一下，例如静态变量需要保护吗？直接传入一个静态函数需要吗？