此页面由 Cloud Translation API 翻译。

gpg::RealTimeMultiplayerManager

#include <real_time_multiplayer_manager.h>

提取、修改、处理消息传递对象，并创建 RealTimeRoom 对象。

总结

公共类型
`FetchInvitationsCallback`	typedef `std::function< void(const FetchInvitationsResponse &)>` 定义可用于从其中一个实时多人游戏操作接收 `WaitingRoomUIResponse` 的回调。
`LeaveRoomCallback`	typedef `std::function< void(const ResponseStatus &)>` 定义可从 `LeaveRoom` 接收 `ResponseStatus` 的回调。
`PlayerSelectUICallback`	typedef `std::function< void(const PlayerSelectUIResponse &)>` 定义可从 `ShowPlayerSelectUI` 接收 `PlayerSelectUIResponse` 的回调。
`PlayerSelectUIResponse`	typedef `TurnBasedMultiplayerManager::PlayerSelectUIResponse` 适用于 `ShowPlayerSelectUI` 操作的 `Data` 和 `ResponseStatus`。
`RealTimeRoomCallback`	typedef `std::function< void(const RealTimeRoomResponse &)>` 定义一个回调，用于通过某个回合制多人游戏接收 `RealTimeRoomResponse` 结构体。
`RoomInboxUICallback`	typedef `std::function< void(const RoomInboxUIResponse &)>` 定义可从 `ShowRoomInboxUI` 接收 `RoomInboxUIResponse` 的回调。
`SendReliableMessageCallback`	typedef `std::function< void(const MultiplayerStatus &)>` 定义可从 `SendReliableMessage` 接收 `ResponseStatus` 的回调。
`WaitingRoomUICallback`	typedef `std::function< void(const WaitingRoomUIResponse &)>` 定义可用于从其中一个实时多人游戏操作接收 `WaitingRoomUIResponse` 的回调。

公共函数
`AcceptInvitation(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback)`	`void` 异步接受 `MultiplayerInvitation`，并通过 `RealTimeRoomCallback` 返回结果。
`AcceptInvitation(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)`	`void` 异步接受 `MultiplayerInvitation`，并通过 `RealTimeRoomCallback` 返回结果。
`AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)`	`RealTimeRoomResponse` 屏蔽版本的 AcceptInvitation。
`AcceptInvitationBlocking(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)`	`RealTimeRoomResponse` AcceptInvitationBlock 的过载，其默认超时时间为 10 年。
`AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)`	`RealTimeRoomResponse` 屏蔽版本的 AcceptInvitation。
`AcceptInvitationBlocking(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)`	`RealTimeRoomResponse` AcceptInvitationBlock 的过载，其默认超时时间为 10 年。
`CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)`	`void` 使用提供的 `RealTimeRoomConfig` 类异步创建 `RealTimeRoom` 对象。
`CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)`	`void` 使用提供的 `RealTimeRoomConfig` 类异步创建 `RealTimeRoom` 对象。
`CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)`	`RealTimeRoomResponse` 屏蔽版本的 CreateRealTimeRoom。
`CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, IRealTimeEventListener *listener)`	`RealTimeRoomResponse` CreateRealTimeRoomBlock 的过载，其默认超时时间为 10 年。
`CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)`	`RealTimeRoomResponse` 屏蔽版本的 CreateRealTimeRoom。
`CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)`	`RealTimeRoomResponse` CreateRealTimeRoomBlock 的过载，其默认超时时间为 10 年。
`DeclineInvitation(const MultiplayerInvitation & invitation)`	`void` 拒绝 `MultiplayerInvitation` 到 `RealTimeRoom`。
`DismissInvitation(const MultiplayerInvitation & invitation)`	`void` 将 `MultiplayerInvitation` 转换为 `RealTimeRoom`。
`FetchInvitations(FetchInvitationsCallback callback)`	`void` 获取实时聊天室的所有 `MultiplayerInvitation`。
`FetchInvitationsBlocking(Timeout timeout)`	`FetchInvitationsResponse` 屏蔽版本的 FetchInvitations。
`FetchInvitationsBlocking()`	`FetchInvitationsResponse` FetchInvitationsBlock 的过载，其默认超时时间为 10 年。
`LeaveRoom(const RealTimeRoom & room, LeaveRoomCallback callback)`	`void` 退出 `RealTimeRoom`。
`LeaveRoomBlocking(Timeout timeout, const RealTimeRoom & room)`	`ResponseStatus` 屏蔽版本的 LeaveRoom。
`LeaveRoomBlocking(const RealTimeRoom & room)`	`ResponseStatus` LeaveRoomBlock 的过载，默认超时为 10 年。
`SendReliableMessage(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback)`	`void` 向指定的 `MultiplayerParticipant` 发送消息。
`SendReliableMessageBlocking(Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)`	`MultiplayerStatus` 屏蔽版本的 SendReliableMessage。
`SendReliableMessageBlocking(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)`	`MultiplayerStatus` SendReliableMessageBlock 的过载，其默认超时时间为 10 年。
`SendUnreliableMessage(const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)`	`void` 向指定的 `MultiplayerParticipant` 发送消息。
`SendUnreliableMessageToOthers(const RealTimeRoom & room, std::vector< uint8_t > data)`	`void` 向除当前用户以外的所有参与者发送消息。
`ShowPlayerSelectUI(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback)`	`void` 异步显示玩家选择界面，允许玩家选择其他加入聊天室的玩家。
`ShowPlayerSelectUIBlocking(Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)`	`PlayerSelectUIResponse` 屏蔽版本的 ShowPlayerSelectUI。
`ShowPlayerSelectUIBlocking(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)`	`PlayerSelectUIResponse` ShowPlayerSelectUIBlock 的过载，默认超时为 10 年。
`ShowRoomInboxUI(RoomInboxUICallback callback)`	`void` 异步显示聊天室收件箱界面，允许玩家选择多人游戏邀请。
`ShowRoomInboxUIBlocking(Timeout timeout)`	`RoomInboxUIResponse` 屏蔽 ShowRoomInboxUI 版本。
`ShowRoomInboxUIBlocking()`	`RoomInboxUIResponse` ShowRoomInboxUIBlocking 的过载，其默认超时时间为 10 年。
`ShowWaitingRoomUI(const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)`	`void` 显示等候室界面，其中会显示多人游戏参与者加入此聊天室的状态。
`ShowWaitingRoomUIBlocking(Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)`	`WaitingRoomUIResponse` 屏蔽版本的 ShowWaitRoomUI。
`ShowWaitingRoomUIBlocking(const RealTimeRoom & room, uint32_t min_participants_to_start)`	`WaitingRoomUIResponse` ShowWaitRoomUIBlock 的过载，其默认超时时间为 10 年。

结构体
gpg::RealTimeMultiplayerManager::FetchInvitationsResponse	适用于 `FetchInvitations` 操作的 `Data` 和 `ResponseStatus`。
gpg::RealTimeMultiplayerManager::RealTimeRoomResponse	针对特定 `RealTimeRoom` 对象的 `Data` 和 `ResponseStatus`。
gpg::RealTimeMultiplayerManager::RoomInboxUIResponse	适用于 `ShowRoomInboxUI` 操作的 `Data` 和 `ResponseStatus`。
gpg::RealTimeMultiplayerManager::WaitRoomUIResponse	适用于 `ShowWaitingRoomUI` 操作的 `Data` 和 `ResponseStatus`。

公共类型

FetchInvitationsCallback

std::function< void(const FetchInvitationsResponse &)> FetchInvitationsCallback

定义可用于从其中一个实时多人游戏操作接收 WaitingRoomUIResponse 的回调。

退出 RoomCallback

std::function< void(const ResponseStatus &)> LeaveRoomCallback

定义可从 LeaveRoom 接收 ResponseStatus 的回调。

播放器选择界面回调

std::function< void(const PlayerSelectUIResponse &)> PlayerSelectUICallback

定义可从 ShowPlayerSelectUI 接收 PlayerSelectUIResponse 的回调。

玩家选择界面响应

TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse

适用于 ShowPlayerSelectUI 操作的 Data 和 ResponseStatus。

这是与回合制多人游戏分享的。

RealTimeRoomCallback

std::function< void(const RealTimeRoomResponse &)> RealTimeRoomCallback

定义一个回调，用于通过某个回合制多人游戏接收 RealTimeRoomResponse 结构体。

RoomInboxUICallback

std::function< void(const RoomInboxUIResponse &)> RoomInboxUICallback

定义可从 ShowRoomInboxUI 接收 RoomInboxUIResponse 的回调。

发送 ReliableMessageCallback

std::function< void(const MultiplayerStatus &)> SendReliableMessageCallback

定义可从 SendReliableMessage 接收 ResponseStatus 的回调。

WaitRoomUICallback

std::function< void(const WaitingRoomUIResponse &)> WaitingRoomUICallback

定义可用于从其中一个实时多人游戏操作接收 WaitingRoomUIResponse 的回调。

公共函数

接受邀请

void AcceptInvitation(
  const MultiplayerInvitation & invitation,
  IRealTimeEventListener *listener,
  RealTimeRoomCallback callback
)

异步接受 MultiplayerInvitation，并通过 RealTimeRoomCallback 返回结果。

接受邀请

void AcceptInvitation(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper,
  RealTimeRoomCallback callback
)

异步接受 MultiplayerInvitation，并通过 RealTimeRoomCallback 返回结果。

AcceptInvitation 屏蔽

RealTimeRoomResponse AcceptInvitationBlocking(
  Timeout timeout,
  const MultiplayerInvitation & invitation,
  IRealTimeEventListener *listener
)

屏蔽版本的 AcceptInvitation。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

AcceptInvitation 屏蔽

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  IRealTimeEventListener *listener
)

AcceptInvitationBlock 的过载，其默认超时时间为 10 年。

AcceptInvitation 屏蔽

RealTimeRoomResponse AcceptInvitationBlocking(
  Timeout timeout,
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

屏蔽版本的 AcceptInvitation。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

AcceptInvitation 屏蔽

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

AcceptInvitationBlock 的过载，其默认超时时间为 10 年。

CreateRealTimeRoom

void CreateRealTimeRoom(
  const gpg::RealTimeRoomConfig & config,
  IRealTimeEventListener *listener,
  RealTimeRoomCallback callback
)

使用提供的 RealTimeRoomConfig 类异步创建 RealTimeRoom 对象。

如果创建成功，此函数将通过提供的 RealTimeRoomCallback 返回 RealTimeRoom 对象。

CreateRealTimeRoom

void CreateRealTimeRoom(
  const gpg::RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper,
  RealTimeRoomCallback callback
)

使用提供的 RealTimeRoomConfig 类异步创建 RealTimeRoom 对象。

如果创建成功，此函数将通过提供的 RealTimeRoomCallback 返回 RealTimeRoom 对象。

CreateRealTimeRoomBlock

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  Timeout timeout,
  const RealTimeRoomConfig & config,
  IRealTimeEventListener *listener
)

屏蔽版本的 CreateRealTimeRoom。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

CreateRealTimeRoomBlock

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  IRealTimeEventListener *listener
)

CreateRealTimeRoomBlock 的过载，其默认超时时间为 10 年。

CreateRealTimeRoomBlock

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  Timeout timeout,
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

屏蔽版本的 CreateRealTimeRoom。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

CreateRealTimeRoomBlock

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

CreateRealTimeRoomBlock 的过载，其默认超时时间为 10 年。

拒绝邀请

void DeclineInvitation(
  const MultiplayerInvitation & invitation
)

拒绝 MultiplayerInvitation 到 RealTimeRoom。

执行此操作会取消其他参与者的会议室，并从本地玩家的设备中移除该会议室。

忽略邀请

void DismissInvitation(
  const MultiplayerInvitation & invitation
)

将 MultiplayerInvitation 转换为 RealTimeRoom。

这不会改变 RealTimeRoom 的可见状态，但会将其从本地玩家的设备中移除。

提取邀请

void FetchInvitations(
  FetchInvitationsCallback callback
)

获取实时聊天室的所有 MultiplayerInvitation。

提取的 MultiplayerInvitation 通过提供的 FetchInvitationsCallback 返回。

提取邀请屏蔽

FetchInvitationsResponse FetchInvitationsBlocking(
  Timeout timeout
)

屏蔽版本的 FetchInvitations。

允许调用方指定超时（以毫秒为单位）。在等待时间过去后，该函数将返回 ERROR_TIMEOUT。

提取邀请屏蔽

FetchInvitationsResponse FetchInvitationsBlocking()

FetchInvitationsBlock 的过载，其默认超时时间为 10 年。

退出聊天室

void LeaveRoom(
  const RealTimeRoom & room,
  LeaveRoomCallback callback
)

退出 RealTimeRoom。

在此操作完成之前，您不应创建新聊天室或尝试加入其他聊天室。此操作的结果是通过 LeaveRoomCallback 返回的。

退出 Room 屏蔽

ResponseStatus LeaveRoomBlocking(
  Timeout timeout,
  const RealTimeRoom & room
)

屏蔽版本的 LeaveRoom。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

退出 Room 屏蔽

ResponseStatus LeaveRoomBlocking(
  const RealTimeRoom & room
)

LeaveRoomBlock 的过载，默认超时为 10 年。

发送 ReliableMessage

void SendReliableMessage(
  const RealTimeRoom & room,
  const MultiplayerParticipant & participant,
  std::vector< uint8_t > data,
  SendReliableMessageCallback callback
)

向指定的 MultiplayerParticipant 发送消息。

使用可靠的方法发送消息。这种发送数据的方法可能会比不可靠地发送信息更长的时间。发送结果通过提供的回调函数报告。

发送 ReliableMessage 屏蔽

MultiplayerStatus SendReliableMessageBlocking(
  Timeout timeout,
  const RealTimeRoom & room,
  const MultiplayerParticipant & participant,
  std::vector< uint8_t > data
)

屏蔽版本的 SendReliableMessage。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

发送 ReliableMessage 屏蔽

MultiplayerStatus SendReliableMessageBlocking(
  const RealTimeRoom & room,
  const MultiplayerParticipant & participant,
  std::vector< uint8_t > data
)

SendReliableMessageBlock 的过载，其默认超时时间为 10 年。

发送不可靠的消息

void SendUnreliableMessage(
  const RealTimeRoom & room,
  const std::vector< MultiplayerParticipant > & participants,
  std::vector< uint8_t > data
)

向指定的 MultiplayerParticipant 发送消息。

使用不可靠的方法来发送消息。这种发送数据的方法要比可靠地发送数据更快，因此应尽可能优先发送。

向他人发送不可靠的消息

void SendUnreliableMessageToOthers(
  const RealTimeRoom & room,
  std::vector< uint8_t > data
)

向除当前用户以外的所有参与者发送消息。

使用不可靠的方法来发送消息。这种发送数据的方法要比可靠地发送数据更快，因此应尽可能优先发送。

ShowPlayerSelectUI

void ShowPlayerSelectUI(
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch,
  PlayerSelectUICallback callback
)

异步显示玩家选择界面，允许玩家选择其他加入聊天室的玩家。

完成后，选定的玩家将通过 PlayerSelectUICallback 返回。

ShowPlayerSelectUIBlocked

PlayerSelectUIResponse ShowPlayerSelectUIBlocking(
  Timeout timeout,
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch
)

屏蔽版本的 ShowPlayerSelectUI。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

ShowPlayerSelectUIBlocked

PlayerSelectUIResponse ShowPlayerSelectUIBlocking(
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch
)

ShowPlayerSelectUIBlock 的过载，默认超时为 10 年。

ShowRoomInboxUI

void ShowRoomInboxUI(
  RoomInboxUICallback callback
)

异步显示聊天室收件箱界面，允许玩家选择多人游戏邀请。

完成后，系统会通过 RoomInboxUIResponse 返回所选邀请。

ShowRoomInboxUI 屏蔽

RoomInboxUIResponse ShowRoomInboxUIBlocking(
  Timeout timeout
)

屏蔽 ShowRoomInboxUI 版本。

允许调用方指定超时（以毫秒为单位）。在指定的时间过后，该函数会返回 ERROR_TIMEOUT。

ShowRoomInboxUI 屏蔽

RoomInboxUIResponse ShowRoomInboxUIBlocking()

ShowRoomInboxUIBlocking 的过载，其默认超时时间为 10 年。

ShowWaitRoom 界面

void ShowWaitingRoomUI(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start,
  WaitingRoomUICallback callback
)

显示等候室界面，其中会显示多人游戏参与者加入此聊天室的状态。

ShowWaitRoomUI 屏蔽

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  Timeout timeout,
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

屏蔽版本的 ShowWaitRoomUI。

允许调用方指定超时（以毫秒为单位）。在等待时间过去后，该函数将返回 ERROR_TIMEOUT。

ShowWaitRoomUI 屏蔽

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

ShowWaitRoomUIBlock 的过载，其默认超时时间为 10 年。