PartyLocalEndpoint::FlushMessages

Erzwingt, dass alle Nachrichten in der Warteschlange an die angegebenen Endpunkte von diesem lokalen Endpunkt so schnell wie möglich gesendet werden, unabhängig von ihren Einstellungen für die Zusammenführung.

Syntax

PartyError FlushMessages(  
    uint32_t targetEndpointCount,  
    PartyEndpointArray targetEndpoints  
)  

Parameter

targetEndpointCount uint32_t

Dieser Parameter wird derzeit ignoriert. Die Anzahl der Zielendpunkte im targetEndpoints Array.

targetEndpoints PartyEndpointArray
Eingabearray der Größe targetEndpointCount

Dieser Parameter wird derzeit ignoriert. Ein targetEndpointCount Einstiegsarray von PartyEndpoint-Zielobjektzeigern. Nachrichten von diesem lokalen Endpunkt bis einschließlich der neuesten Nachricht an einen beliebigen Endpunkt im Array werden so bald wie möglich übertragen.

Rückgabewert

PartyError

c_partyErrorSuccess , wenn das Leeren von Meldungen erfolgreich war, andernfalls ein Fehlercode. Die lesbare Form des Fehlercodes kann über PartyManager::GetErrorMessage() abgerufen werden.

Hinweise

Wenn PartySendMessageOptions::CoalesceOpportunististisch oder PartySendMessageOptions::AlwaysCoalesceUntilFlushed in einem Aufruf von SendMessage() angegeben wird, kann die Nachricht nicht sofort übertragen und stattdessen mit anderen Nachrichten kombiniert werden. Diese Zusammenführung kann die Bandbreiteneffizienz auf Kosten der wahrgenommenen Latenz verbessern. Diese Methode ermöglicht es dem Titel, manuell zu erzwingen, dass solche zusammengeflosten Nachrichten so schnell wie möglich mit der Übertragung beginnen.

Derzeit ignoriert diese Methode den targetEndpoints Parameter und erzwingt, dass alle Nachrichten in der Warteschlange von diesem lokalen Endpunkt so schnell wie möglich übertragen werden.

Voraussetzungen

Header: Party.h

Weitere Informationen

PartyLocalEndpoint
PartyLocalEndpoint::SendMessage
PartySendMessageOptions