ISynchronize
COM公式ドキュメント
ISynchronize (objidlbase.h) インターフェースは、イベントの発生についてオブジェクト間で非同期の通信を提供します。
メソッド 3
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
ISynchronize::Wait (objidlbase.h) メソッドは、同期オブジェクトがシグナル状態になるか、指定したタイムアウト時間が経過するまで待機します。
| dwFlags | DWORD | in | 待機オプション。指定できる値は COWAIT_FLAGS 列挙体から取得します。 |
| dwMilliseconds | DWORD | in | この呼び出しが戻るまで待機する時間(ミリ秒単位)。このパラメーターが INFINITE の場合、呼び出し元は、時間がどれだけかかっても同期オブジェクトがシグナル状態になるまで待機します。このパラメーターが 0 の場合、メソッドはただちに戻ります。 |
戻り値
このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、および E_FAIL に加えて、以下の値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 同期オブジェクトがシグナル状態になりました。 | |
|
同期オブジェクトがシグナル状態になる前にタイムアウト時間が経過しました。 |
解説(Remarks)
呼び出し元がシングルスレッドアパートメントで待機している場合、Wait は COM モーダルループに入ります。呼び出し元がマルチスレッドアパートメントで待機している場合、Wait が戻るまで呼び出し元はブロックされます。
ISynchronize::Signal (objidlbase.h) メソッドは、同期オブジェクトをシグナル状態に設定し、保留中の待機操作を S_OK で戻します。
戻り値
このメソッドは、メソッドが正常に完了したことを示すために S_OK を返します。
ISynchronize::Reset (objidlbase.h) メソッドは、同期オブジェクトを非シグナル状態に設定します。
戻り値
このメソッドは、メソッドが正常に完了したことを示すために S_OK を返します。
解説(Remarks)
標準イベントオブジェクト (CLSID_StdEvent) に実装された ISynchronize::Wait メソッドは、同期オブジェクトがシグナル状態になったときに自動的に Reset を呼び出します。
手動リセットイベントオブジェクト (CLSID_ManualResetEvent) 上の ISynchronize::Wait の実装は、Reset を自動的には呼び出しません。通常、サーバーオブジェクトは、クライアントが同期オブジェクトのシグナル状態を検出した後に呼び出すメソッドの中から Reset を呼び出します。
一般に、Reset を呼び出す責任はサーバーにあります。ただし、クライアントが同期オブジェクトを非シグナル状態から開始する必要がある場合は、クライアントが Reset を呼び出す必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ISynchronize "{00000030-0000-0000-C000-000000000046}"
#usecom global ISynchronize IID_ISynchronize "{}"
#comfunc global ISynchronize_Wait 3 int,int
#comfunc global ISynchronize_Signal 4
#comfunc global ISynchronize_Reset 5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。