IPipeByte

COM

IIDdb2f3aca-2f86-11d1-8e04-00c04fb9989a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IPipeByte (objidlbase.h) インターフェイスは、byte 型(8 ビット幅)のデータを転送します。

解説(Remarks)

IPipeByte、IPipeDouble、および IPipeLong の各インターフェイスは、標準の DCE/RPC パイプに似ています。ただし、COM によるパイプの実装は、より高い柔軟性を提供します。COM の実装における基本的な考え方は、パイプが Pull と Push という 2 つのメソッドを持つ単なる別のインターフェイスにすぎない、というものです。これにより、主に次の 3 つの利点が得られます。

COM パイプはインターフェイスの一種であるため、メソッド呼び出しの out パラメーターとして受け取り、その後 Pull または Push を呼び出すことができます。
Pull および Push メソッドを呼び出すタイミングに制約がないため、パイプは実際には双方向です。
パイプはインターフェイスであるため、メソッド呼び出しを非同期にすることができ、非同期のルールに従います。

詳細については、RPC ドキュメントの Pipes を参照してください。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT Pull(BYTE* buf, DWORD cRequest, DWORD* pcReturned)

IPipeByte::Pull (objidlbase.h) メソッドは、パイプのソースから byte 型のデータを取得します。

buf	BYTE*	out	データを受け取るメモリバッファーへのポインター。バッファーは、少なくとも cRequest に指定されたバイト数を保持できる必要があります。
cRequest	DWORD	in	要求するバイト数。
pcReturned	DWORD*	out	実際に返されたバイト数。

戻り値

データが正常に取得されたことを示すために、このメソッドは S_OK を返します。

解説(Remarks)

Pull メソッドが呼び出されると、パイプのプロバイダーにデータが要求されます。呼び出し側は、少なくとも cRequest パラメーターに指定されたバイト数を保持できるバッファーを提供する必要があります。プロキシはデータを指定されたバッファーにアンマーシャリングし、実際に提供されたバイト数を pcReturned に設定します。pcReturned パラメーターは cRequest 以下になることはありますが、それを超えることはありません。pcReturned が 0 の場合は、これ以上データがないことを示します。

vtbl 4 HRESULT Push(BYTE* buf, DWORD cSent)

IPipeByte::Push (objidlbase.h) メソッドは、byte 型のデータをパイプのソースに送信します。

buf	BYTE*	in	送信するデータを保持するメモリバッファーへのポインター。
cSent	DWORD	in	バッファー内のバイト数。

戻り値

データが正常に送信されたことを示すために、このメソッドは S_OK を返します。

解説(Remarks)

Push メソッドが呼び出されると、データがパイプのプロバイダーに送信されます。呼び出し側はバッファーにデータを設定してから Push を呼び出します。送信されるバイト数は cSent パラメーターに指定します。呼び出し側は、呼び出しの間じゅうバッファーが有効であることを保証する責任があります。

最後のデータをプッシュし終えたら、呼び出し側は最後に cSent を 0 として 1 回プッシュを行い、データ転送が完了したことを示す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IPipeByte "{DB2F3ACA-2F86-11D1-8E04-00C04FB9989A}"
#usecom global IPipeByte IID_IPipeByte "{}"
#comfunc global IPipeByte_Pull  3 var,int,var
#comfunc global IPipeByte_Push  4 var,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IPipeByte "{DB2F3ACA-2F86-11D1-8E04-00C04FB9989A}"
#usecom global IPipeByte IID_IPipeByte "{}"
#comfunc global IPipeByte_Pull  3 sptr,int,sptr
#comfunc global IPipeByte_Push  4 sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。