WBT_SetPacketSize

構文

#include <nitro/wbt.h>

BOOL WBT_SetPacketSize(int send_packet_size, int recv_packet_size );

引数

send_packet_size WBTのために使用することのできるMP通信の親機パケットサイズ
この値はWBT_PACKET_SIZE_MINバイト以上である必要があります。
recv_packet_size WBTのために使用することのできるMP通信の子機パケットサイズ
この値はWBT_PACKET_SIZE_MINバイト以上である必要があります。

返り値

現在パケットサイズを変更可能であれば TRUE を、そうでないなら FALSE を返します。

説明

WBT ライブラリの親機がWBT_InitParent( )で指定したパケットサイズを
初期化後の任意のタイミングで動的に変更するために使用します。
成功すれば、関数はただちに制御を返します。

データシェアリング等、WBT以外での通信ポート併用の有無に合わせて
この関数でパケットサイズを変更することで転送効率を調整することができます。

注意

この関数はユーザアプリケーション側での論理的な制御を前提として呼び出し可能なもので、
常に安全な動作を保証されているものではありません。

各子機はWBT_RequestSync( )で最後に親機から取得したパケットサイズ設定に基づいて、
WBT_GetBlock( )での転送単位サイズやビットマップバッファサイズを計算します。
よって、任意のWBT_GetBlock( )でデータ受信が行われている最中にパケットサイズを変更することはできません。

以下の条件を全て満たす場合にのみ、この関数を安全に使用できる点に注意してください。

・親機がこの関数を呼び出す時点でWBT_GetBlock( )によるデータ転送を誰も実行中ではない。
・親機がこの関数を呼び出した後、子機はWBT_GetBlock( )の前に必ず1回はWBT_RequestSync( )を呼び出す。

この関数自体が内部で行うことのできる判定は上記条件の一部分のみで、
この関数が TRUE を返したことが上記条件を全て満たしたことと同値ではない点にも注意してください。

参照

WBT_InitParent, WBT_RequestSync, WBT_GetBlock

履歴

2004/09/21 初版