本機 C++ 中的事件處理
在處理本機 C ++ 事件時,您分別使用 event_source 和 event_receiver 特性設置事件源和事件接收器,并指定 type=native。這些特性允許應用它們的類在本機的非 COM 上下文中激發和處理事件。
聲明事件
在事件源類中,對一個方法聲明使用 __event關鍵字可將該方法聲明為事件。請確保聲明該方法,但不要定義它;這樣做會產生編譯器錯誤,因為將該方法轉換為事件時編譯器會隱式定義它。本機事件可以是帶有零個或多個參數的方法。返回類型可以是 void 或任何整型。
定義事件處理程序
在事件接收器類中,可定義事件處理程序,這些處理程序是具有與它們將處理的事件匹配的簽名(返回類型、調用約定和參數)的方法。
將事件處理程序掛鉤到事件
同樣在事件接收器類中,可使用內部函數 __hook 將事件與事件處理程序關聯,并可使用 __unhook 取消事件與事件處理程序的關聯。您可將多個事件掛鉤到一個事件處理程序,或將多個事件處理程序掛鉤到一個事件。
激發事件
若要激發事件,只需調用聲明為事件源類中的事件的方法即可。如果處理程序已掛鉤到事件,則將調用處理程序。
本機 C++ 事件代碼
以下示例演示如何在本機 C++ 中激發事件。若要編譯并運行此示例,請參考代碼中的注釋。
示例代碼
// evh_native.cpp#include <stdio.h>[event_source(native)]class CSource {public: __event void MyEvent(int nValue);};[event_receiver(native)]class CReceiver {public: void MyHandler1(int nValue) { printf_s("MyHandler1 was called with value %d./n", nValue); } void MyHandler2(int nValue) { printf_s("MyHandler2 was called with value %d./n", nValue); } void hookEvent(CSource* pSource) { __hook(&CSource::MyEvent, pSource, &CReceiver::MyHandler1); __hook(&CSource::MyEvent, pSource, &CReceiver::MyHandler2); } void unhookEvent(CSource* pSource) { __unhook(&CSource::MyEvent, pSource, &CReceiver::MyHandler1); __unhook(&CSource::MyEvent, pSource, &CReceiver::MyHandler2); }};int main() { CSource source; CReceiver receiver; receiver.hookEvent(&source); __raise source.MyEvent(123); receiver.unhookEvent(&source);}
輸出:
MyHandler2 was called with value 123.MyHandler1 was called with value 123.
COM 中的事件處理
在 COM 事件處理中,您使用 event_source 和 event_receiver 特性分別設置事件源和事件接收器,并指定 type=com。這些特性為自定義接口、調度接口和雙重接口注入相應的代碼,從而使這些接口能夠應用到的類激發事件并通過 COM 連接點處理事件。
聲明事件
在事件源類中,在接口聲明上使用 __event 關鍵字以將該接口的方法聲明為事件。當您將該接口的事件作為接口方法調用時,將激發這些事件。事件接口上的方法可以有零個或多個參數(應全是 in 參數)。返回類型可以是 void 或任何整型。
定義事件處理程序
在事件接收器類中,可定義事件處理程序,這些處理程序是具有與它們將處理的事件匹配的簽名(返回類型、調用約定和參數)的方法。對于 COM 事件,調用約定不必匹配;有關詳細信息,請參閱下文中的依賴于布局的 COM 事件。
將事件處理程序掛鉤到事件
同樣在事件接收器類中,可使用內部函數 __hook 將事件與事件處理程序關聯,并可使用 __unhook 取消事件與事件處理程序的關聯。您可將多個事件掛鉤到一個事件處理程序,或將多個事件處理程序掛鉤到一個事件。
注意
通常,有兩種方法使 COM 事件接收器能夠訪問事件源接口定義。第一種是共享公共頭文件,如下所示。第二種是將 #import 與 embedded_idl 導入限定符結合使用,以便讓事件源類型庫寫入到保留了特性生成的代碼的 .tlh 文件。
激發事件
若要激發事件,只需調用在事件源類中使用 __event 關鍵字聲明的接口中的方法。如果處理程序已掛鉤到事件,則將調用處理程序。
COM 事件代碼
下面的示例演示如何在 COM 類中激發事件。若要編譯并運行此示例,請參考代碼中的注釋。
// evh_server.h#pragma once[ dual, uuid("00000000-0000-0000-0000-000000000001") ]__interface IEvents { [id(1)] HRESULT MyEvent([in] int value);};[ dual, uuid("00000000-0000-0000-0000-000000000002") ]__interface IEventSource { [id(1)] HRESULT FireEvent();};class DECLSPEC_UUID("530DF3AD-6936-3214-A83B-27B63C7997C4") CSource;
接著是服務器:
// evh_server.cpp// compile with: /LD// post-build command: Regsvr32.exe /s evh_server.dll#define _ATL_ATTRIBUTES 1#include <atlbase.h>#include <atlcom.h>#include "evh_server.h"[ module(dll, name="EventSource", uuid="6E46B59E-89C3-4c15-A6D8-B8A1CEC98830") ];[coclass, event_source(com), uuid("530DF3AD-6936-3214-A83B-27B63C7997C4")]class CSource : public IEventSource {public: __event __interface IEvents; HRESULT FireEvent() { __raise MyEvent(123); return S_OK; }};
再然后是客戶端:
// evh_client.cpp// compile with: /link /OPT:NOREF#define _ATL_ATTRIBUTES 1#include <atlbase.h>#include <atlcom.h>#include <stdio.h>#include "evh_server.h"[ module(name="EventReceiver") ];[ event_receiver(com) ]class CReceiver {public: HRESULT MyHandler1(int nValue) { printf_s("MyHandler1 was called with value %d./n", nValue); return S_OK; } HRESULT MyHandler2(int nValue) { printf_s("MyHandler2 was called with value %d./n", nValue); return S_OK; } void HookEvent(IEventSource* pSource) { __hook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler1); __hook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler2); } void UnhookEvent(IEventSource* pSource) { __unhook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler1); __unhook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler2); }};int main() { // Create COM object CoInitialize(NULL); { IEventSource* pSource = 0; HRESULT hr = CoCreateInstance(__uuidof(CSource), NULL, CLSCTX_ALL, __uuidof(IEventSource), (void **) &pSource); if (FAILED(hr)) { return -1; } // Create receiver and fire event CReceiver receiver; receiver.HookEvent(pSource); pSource->FireEvent(); receiver.UnhookEvent(pSource); } CoUninitialize(); return 0;}
輸出
MyHandler1 was called with value 123.MyHandler2 was called with value 123.
依賴于布局的 COM 事件
布局依賴性只是 COM 編程中的一個問題。在本機和托管事件處理中,處理程序的簽名(返回類型、調用約定和參數)必須與其事件匹配,但處理程序的名稱不必與其事件匹配。
但是,在 COM 事件處理中,如果將 event_receiver 的 layout_dependent 參數設置為 true,則將強制名稱和簽名匹配。這意味著事件接收器中處理程序的名稱和簽名必須與處理程序將掛鉤到的事件的名稱和簽名完全匹配。
當 layout_dependent 設置為 false 時,激發事件方法與掛鉤方法(其委托)之間的調用約定和存儲類(虛擬、靜態等)可以混合和匹配。將 layout_dependent 設置為 true 效率會稍微高一點。
例如,假設 IEventSource 定義為具有下列方法:
[id(1)] HRESULT MyEvent1([in] int value);[id(2)] HRESULT MyEvent2([in] int value);
假定事件源具有以下形式:
[coclass, event_source(com)]class CSource : public IEventSource {public: __event __interface IEvents; HRESULT FireEvent() { MyEvent1(123); MyEvent2(123); return S_OK; }};
則在事件接收器中,掛鉤到 IEventSource 中的方法的任何處理程序必須與其名稱和簽名匹配,如下所示:
[coclass, event_receiver(com, true)]class CReceiver {public: HRESULT MyEvent1(int nValue) { // name and signature matches MyEvent1 ... } HRESULT MyEvent2(E c, char* pc) { // signature doesn't match MyEvent2 ... } HRESULT MyHandler1(int nValue) { // name doesn't match MyEvent1 (or 2) ... } void HookEvent(IEventSource* pSource) { __hook(IFace, pSource); // Hooks up all name-matched events // under layout_dependent = true __hook(&IFace::MyEvent1, pSource, &CReceive::MyEvent1); // valid __hook(&IFace::MyEvent2, pSource, &CSink::MyEvent2); // not valid __hook(&IFace::MyEvent1, pSource, &CSink:: MyHandler1); // not valid }};