PartyLocalEndpoint::FlushMessages
結合設定に関係なく、このローカル エンドポイントから指定されたエンドポイントに対するすべてのキューに入れられたメッセージをできるだけ早く送信するように強制します。
構文
PartyError FlushMessages(
uint32_t targetEndpointCount,
PartyEndpointArray targetEndpoints
)
パラメーター
targetEndpointCount
uint32_t
現在、このパラメーターは無視されます。
targetEndpoints
配列内のターゲット エンドポイントの数。
targetEndpoints
PartyEndpointArray
サイズの入力配列targetEndpointCount
現在、このパラメーターは無視されます。 ターゲットの PartyEndpoint オブジェクト ポインターの targetEndpointCount
エントリ配列。 このローカル エンドポイントからのメッセージ (配列内の任意のエンドポイントへの最新メッセージを含む) は、できるだけ早く送信されます。
戻り値
PartyError
c_partyErrorSuccess
メッセージのフラッシュが成功したかどうか。それ以外の場合にはエラー コード。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。
備考
PartySendMessageOptions::CoalesceOpportunistically または PartySendMessageOptions::AlwaysCoalesceUntilFlushed が SendMessage() の呼び出しで指定されると、メッセージはすぐに送信されず、他のメッセージと結合される場合があります。 この結合により、帯域幅の効率を向上できますが、その代わりに遅延が発生する可能性があります。 このメソッドを使用すると、タイトルは、このような結合されたメッセージをできるだけ早く送信を開始するように手動で強制できます。
現在、このメソッドは targetEndpoints
パラメーターを無視し、このローカル エンドポイントからキューに入れられたすべてのメッセージをできるだけ早く送信するように強制します。
要件
ヘッダー: Party.h
関連項目
PartyLocalEndpoint
PartyLocalEndpoint::SendMessage
PartySendMessageOptions