PartyLocalEndpoint::FlushMessages

强制尽快发送所有从此本地终结点到指定终结点的已排队邮件,而不考虑其合并设置。

语法

PartyError FlushMessages(  
    uint32_t targetEndpointCount,  
    PartyEndpointArray targetEndpoints  
)  

参数

targetEndpointCount uint32_t

当前已忽略此参数。 targetEndpoints 阵列中的目标终结点数量。

targetEndpoints PartyEndpointArray
大小为 targetEndpointCount 的输入数组

当前已忽略此参数。 一个包含目标 PartyEndpoint 对象指针的 targetEndpointCount 条目阵列。 将尽快发送所有从此本地终结点到阵列中任意终结点的邮件(包括最新邮件)。

返回值

PartyError

如果刷新邮件成功,则为 c_partyErrorSuccess,否则为错误代码。 可通过 PartyManager::GetErrorMessage() 检索错误代码的可读形式。

备注

当调用 SendMessage() 时指定 PartySendMessageOptions::CoalesceOpportunisticallyPartySendMessageOptions::AlwaysCoalesceUntilFlushed,该邮件可能不会立即传输,而是与其他邮件组合。 这种合并可以提升带宽效率,代价是会感到延迟。 此方法可允许游戏强制尽快开始传输此类合并邮件。

此方法当前将忽略 targetEndpoints 参数,并强制尽快发送来自此本地终结点的所有已排队邮件。

要求

标题: Party.h

另请参阅

PartyLocalEndpoint
PartyLocalEndpoint::SendMessage
PartySendMessageOptions