《COM技术内幕》读书笔记——第4章 引用计数

      本章介绍COM必须实现的IUnknow接口的两个计数函数——AddRef和Release，简单来说就是智能指针类似的功能。内存分配在组件类中进行，每当组件类的指针外传的时候增加引用，而当传出去的指针使用完毕，减少引用计数。当引用计数减少到0时释放内存。

      需要注意到通用的几个函数实现里都应该加上AddRef，如QueryInterface,CreateInstance。书中强调对象的生命周期范围，这也正是这两个函数设计的目的。

      对于本章，因为我目前没有在大型程序代码中使用COM的经验，虽然感觉生命周期重要，但没有太多深刻体会。而且书上讲解的方式会使人有一定的疲劳。建议初学者可以先跳过，回头再看。我就是按这方法学习的。

      为正确地使用引用计数，读者需要了解以下三条简单的规则：

      1. 在返回之前调用AddRef，对于那些返回接口指针的函数，在返回之前用相应的指针调用AddRef。这些函数包括QueryInterface及CreateInstance。这样当客户从这种函数得到一个接口后，它将无需调用AddRef.

      2. 使用完这些接口之后，Release。

      3. 在赋值之后调用AddRef。在将一个接口指针赋给另外一个接口指针时，应调用AddRef。即在建立接口的另外一个引用之后应增加相应组件的引用计数。

 

      在后面使用智能指针把引用计数完全封装起来的时候，程序员几乎可以把引用计数的问题完全忘掉。

//
// RefCount.cpp
// To compile, use: cl RefCount.cpp UUID.lib
//
#include <iostream.h>
#include <objbase.h>

void trace(const char* msg) { cout << msg << endl ;}

// Forward references for GUIDs
extern const IID IID_IX ;
extern const IID IID_IY ;
extern const IID IID_IZ ;

// Interfaces
interface IX : IUnknown
{
	virtual void __stdcall Fx() = 0 ;
} ;

interface IY : IUnknown
{
	virtual void __stdcall Fy() = 0 ;
} ;

interface IZ : IUnknown
{
	virtual void __stdcall Fz() = 0 ;
} ;


//
// Component
//
class CA : public IX,
           public IY
{
	// IUnknown implementation
	virtual HRESULT __stdcall QueryInterface(const IID& iid, void** ppv) ;			
	virtual ULONG __stdcall AddRef() ;
	virtual ULONG __stdcall Release() ;

	// Interface IX implementation
	virtual void __stdcall Fx() { cout << "Fx" << endl ;}

	// Interface IY implementation
	virtual void __stdcall Fy() { cout << "Fy" << endl ;}

public:
	// Constructor
	CA() : m_cRef(0) {}

	// Destructor
	~CA() { trace("CA:     Destroy self.") ;}

private:
	long m_cRef;
} ;

HRESULT __stdcall CA::QueryInterface(const IID& iid, void** ppv)
{ 	
	if (iid == IID_IUnknown)
	{
		trace("CA QI:  Return pointer to IUnknown.") ;
		*ppv = static_cast<IX*>(this) ;
	} 
	else if (iid == IID_IX)
	{
		trace("CA QI:  Return pointer to IX.") ;
		*ppv = static_cast<IX*>(this) ;
	}
	else if (iid == IID_IY)
	{
		trace("CA QI:  Return pointer to IY.") ;
		*ppv = static_cast<IY*>(this) ;
	}
	else
	{  	   
		trace("CA QI:  Interface not supported.") ;
		*ppv = NULL ;
		return E_NOINTERFACE;
	}
	reinterpret_cast<IUnknown*>(*ppv)->AddRef() ; 
	return S_OK ;
}

ULONG __stdcall CA::AddRef()
{
	cout << "CA:     AddRef = " << m_cRef+1 << '.' << endl ;
	return InterlockedIncrement(&m_cRef) ;
}

ULONG __stdcall CA::Release() 
{
	cout << "CA:     Release = " << m_cRef-1 << '.' << endl ;

	if (InterlockedDecrement(&m_cRef) == 0)
	{
		delete this ;
		return 0 ;
	}
	return m_cRef ;
}

//
// Creation function
//
IUnknown* CreateInstance()
{
	IUnknown* pI = static_cast<IX*>(new CA) ;
	pI->AddRef() ;
	return pI ;
}

//
// IIDs
//
// {32bb8320-b41b-11cf-a6bb-0080c7b2d682}
static const IID IID_IX = 
	{0x32bb8320, 0xb41b, 0x11cf,
	{0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}} ;

// {32bb8321-b41b-11cf-a6bb-0080c7b2d682}
static const IID IID_IY = 
	{0x32bb8321, 0xb41b, 0x11cf,
	{0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}} ;

// {32bb8322-b41b-11cf-a6bb-0080c7b2d682}
static const IID IID_IZ = 
	{0x32bb8322, 0xb41b, 0x11cf,
	{0xa6, 0xbb, 0x0, 0x80, 0xc7, 0xb2, 0xd6, 0x82}} ;

//
// Client
//
int main()
{
	HRESULT hr ;

	trace("Client: Get an IUnknown pointer.") ;
	IUnknown* pIUnknown = CreateInstance() ;


	trace("Client: Get interface IX.") ;

	IX* pIX = NULL ; 
	hr = pIUnknown->QueryInterface(IID_IX, (void**)&pIX) ;

	if (SUCCEEDED(hr))
	{
		trace("Client: Succeeded getting IX.") ;
		pIX->Fx() ;          // Use interface IX.
		pIX->Release() ;
	}


	trace("Client: Get interface IY.") ;

	IY* pIY = NULL ;
	hr = pIUnknown->QueryInterface(IID_IY, (void**)&pIY) ;
	if (SUCCEEDED(hr))
	{
		trace("Client: Succeeded getting IY.") ;
		pIY->Fy() ;          // Use interface IY.
		pIY->Release() ;
	}


	trace("Client: Ask for an unsupported interface.") ;

	IZ* pIZ = NULL ;
	hr = pIUnknown->QueryInterface(IID_IZ, (void**)&pIZ) ;
	if (SUCCEEDED(hr))
	{
		trace("Client: Succeeded in getting interface IZ.") ;
		pIZ->Fz() ;
		pIZ->Release() ;
	}
	else
	{
		trace("Client: Could not get interface IZ.") ;
	}


	trace("Client: Release IUnknown interface.") ;
	pIUnknown->Release() ;

	return 0;
}