гпг:: RealTimeMultiplayerManager

#include <real_time_multiplayer_manager.h>

Извлекает, изменяет, обрабатывает обмен сообщениями и создает объекты RealTimeRoom .

Краткое содержание

Публичные типы

FetchInvitationsCallback определение типа
std::function< void(const FetchInvitationsResponse &)>
Определяет обратный вызов, который можно использовать для получения WaitingRoomUIResponse от одной из многопользовательских операций в реальном времени.
LeaveRoomCallback определение типа
std::function< void(const ResponseStatus &)>
Определяет обратный вызов, который может получить ResponseStatus от LeaveRoom .
PlayerSelectUICallback определение типа
std::function< void(const PlayerSelectUIResponse &)>
Определяет обратный вызов, который может получить PlayerSelectUIResponse от ShowPlayerSelectUI .
PlayerSelectUIResponse определение типа
Data и ResponseStatus для операции ShowPlayerSelectUI .
RealTimeRoomCallback определение типа
std::function< void(const RealTimeRoomResponse &)>
Определяет обратный вызов, который можно использовать для получения структуры RealTimeRoomResponse из одной из пошаговых многопользовательских операций.
RoomInboxUICallback определение типа
std::function< void(const RoomInboxUIResponse &)>
Определяет обратный вызов, который может получить RoomInboxUIResponse от ShowRoomInboxUI .
SendReliableMessageCallback определение типа
std::function< void(const MultiplayerStatus &)>
Определяет обратный вызов, который может получить ResponseStatus от SendReliableMessage .
WaitingRoomUICallback определение типа
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)
Блокирующая версия AcceptInvitation .
AcceptInvitationBlocking (const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
Перегрузка AcceptInvitationBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.
AcceptInvitationBlocking ( Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
Блокирующая версия AcceptInvitation .
AcceptInvitationBlocking (const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
Перегрузка AcceptInvitationBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.
CreateRealTimeRoom (const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
void
Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .
CreateRealTimeRoom (const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
void
Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .
CreateRealTimeRoomBlocking ( Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
Блокирующая версия CreateRealTimeRoom .
CreateRealTimeRoomBlocking (const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
Перегрузка CreateRealTimeRoomBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.
CreateRealTimeRoomBlocking ( Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
Блокирующая версия CreateRealTimeRoom .
CreateRealTimeRoomBlocking (const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
Перегрузка CreateRealTimeRoomBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.
DeclineInvitation (const MultiplayerInvitation & invitation)
void
Отклоняет MultiplayerInvitation в RealTimeRoom .
DismissInvitation (const MultiplayerInvitation & invitation)
void
Отклоняет MultiplayerInvitation в RealTimeRoom .
FetchInvitations ( FetchInvitationsCallback callback)
void
Извлекает любые MultiplayerInvitation для комнат реального времени.
FetchInvitationsBlocking ( Timeout timeout)
Блокирующая версия FetchInvitations .
FetchInvitationsBlocking ()
Перегрузка FetchInvitationsBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.
LeaveRoom (const RealTimeRoom & room, LeaveRoomCallback callback)
void
Оставляет RealTimeRoom .
LeaveRoomBlocking ( Timeout timeout, const RealTimeRoom & room)
Блокирующая версия LeaveRoom .
LeaveRoomBlocking (const RealTimeRoom & room)
Перегрузка LeaveRoomBlocking , которая использует тайм-аут по умолчанию, равный 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)
Блокирующая версия SendReliableMessage .
SendReliableMessageBlocking (const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
Перегрузка SendReliableMessageBlocking , которая использует время ожидания по умолчанию 10 лет.
SendUnreliableMessage (const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)
void
Отправляет сообщение указанному MultiplayerParticipant s.
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)
Блокирующая версия ShowPlayerSelectUI .
ShowPlayerSelectUIBlocking (uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
Перегрузка ShowPlayerSelectUIBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.
ShowRoomInboxUI ( RoomInboxUICallback callback)
void
Асинхронно отображает пользовательский интерфейс папки «Входящие» комнаты, позволяя игроку выбрать приглашение для многопользовательской игры.
ShowRoomInboxUIBlocking ( Timeout timeout)
Блокирующая версия ShowRoomInboxUI .
ShowRoomInboxUIBlocking ()
Перегрузка 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)
Блокирующая версия ShowWaitingRoomUI .
ShowWaitingRoomUIBlocking (const RealTimeRoom & room, uint32_t min_participants_to_start)
Перегрузка ShowWaitingRoomUIBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

Структуры

gpg:: RealTimeMultiplayerManager:: FetchInvitationsResponse

Data и ResponseStatus для операции FetchInvitations .

gpg:: RealTimeMultiplayerManager:: RealTimeRoomResponse

Data и ResponseStatus для конкретного объекта RealTimeRoom .

gpg:: RealTimeMultiplayerManager:: RoomInboxUIResponse

Data и ResponseStatus для операции ShowRoomInboxUI .

gpg:: RealTimeMultiplayerManager:: WaitingRoomUIResponse

Data и ResponseStatus для операции ShowWaitingRoomUI .

Публичные типы

FetchInvitationsОбратный вызов 

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

Определяет обратный вызов, который можно использовать для получения WaitingRoomUIResponse от одной из многопользовательских операций в реальном времени.

Выход из комнатыОбратный вызов 

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

Определяет обратный вызов, который может получить ResponseStatus от LeaveRoom .

PlayerSelectUICallback 

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

Определяет обратный вызов, который может получить PlayerSelectUIResponse от ShowPlayerSelectUI .

PlayerSelectUIResponse 

TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse

Data и ResponseStatus для операции ShowPlayerSelectUI .

Это общее с пошаговым многопользовательским режимом.

RealTimeRoomОбратный вызов 

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

Определяет обратный вызов, который можно использовать для получения структуры RealTimeRoomResponse из одной из пошаговых многопользовательских операций.

КомнатаВходящиеUIОбратный вызов 

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

Определяет обратный вызов, который может получить RoomInboxUIResponse от ShowRoomInboxUI .

ОтправитьReliableMessageОбратный вызов 

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

Определяет обратный вызов, который может получить ResponseStatus от SendReliableMessage .

ОжиданиеКомнатаUIОбратный вызов 

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 .

AcceptInvitationBlocking 

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

Блокирующая версия AcceptInvitation .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

AcceptInvitationBlocking 

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

Перегрузка AcceptInvitationBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

AcceptInvitationBlocking 

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

Блокирующая версия AcceptInvitation .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

AcceptInvitationBlocking 

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

Перегрузка AcceptInvitationBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

Создать комнату реального времени 

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

Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .

Если создание прошло успешно, эта функция возвращает объект RealTimeRoom через предоставленный RealTimeRoomCallback .

Создать комнату реального времени 

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

Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .

Если создание прошло успешно, эта функция возвращает объект RealTimeRoom через предоставленный RealTimeRoomCallback .

CreateRealTimeRoomBlocking 

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

Блокирующая версия CreateRealTimeRoom .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

CreateRealTimeRoomBlocking 

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

Перегрузка CreateRealTimeRoomBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

CreateRealTimeRoomBlocking 

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

Блокирующая версия CreateRealTimeRoom .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

CreateRealTimeRoomBlocking 

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

Перегрузка CreateRealTimeRoomBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

Отклонить приглашение 

void DeclineInvitation(
  const MultiplayerInvitation & invitation
)

Отклоняет MultiplayerInvitation в RealTimeRoom .

При этом комната для других участников будет отменена, а комната будет удалена с устройства локального игрока.

Отклонить приглашение 

void DismissInvitation(
  const MultiplayerInvitation & invitation
)

Отклоняет MultiplayerInvitation в RealTimeRoom .

Это не меняет видимое состояние RealTimeRoom для других участников, но удаляет его с устройства локального игрока.

FetchInvitations 

void FetchInvitations(
  FetchInvitationsCallback callback
)

Извлекает любые MultiplayerInvitation для комнат реального времени.

Извлеченные MultiplayerInvitation возвращаются через предоставленный FetchInvitationsCallback .

Блокировка FetchInvitations 

FetchInvitationsResponse FetchInvitationsBlocking(
  Timeout timeout
)

Блокирующая версия FetchInvitations .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция вернет ERROR_TIMEOUT .

Блокировка FetchInvitations 

FetchInvitationsResponse FetchInvitationsBlocking()

Перегрузка FetchInvitationsBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

Выйти из комнаты 

void LeaveRoom(
  const RealTimeRoom & room,
  LeaveRoomCallback callback
)

Оставляет RealTimeRoom .

Не следует создавать новую комнату или пытаться присоединиться к другой комнате до завершения этой операции. Результат этой операции возвращается через LeaveRoomCallback .

Выход из комнатыБлокировка 

ResponseStatus LeaveRoomBlocking(
  Timeout timeout,
  const RealTimeRoom & room
)

Блокирующая версия LeaveRoom .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

Выход из комнатыБлокировка 

ResponseStatus LeaveRoomBlocking(
  const RealTimeRoom & room
)

Перегрузка LeaveRoomBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

ОтправитьReliableMessage 

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

Отправляет сообщение указанному MultiplayerParticipant .

Использует надежный метод для отправки сообщения. Этот метод отправки данных может занять больше времени, чем ненадежная отправка сообщения. Результат отправки сообщается через предоставленный обратный вызов.

Блокировка отправки надежного сообщения 

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

Блокирующая версия SendReliableMessage .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

Блокировка отправки надежного сообщения 

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

Перегрузка SendReliableMessageBlocking , которая использует время ожидания по умолчанию 10 лет.

ОтправитьUnreliableMessage 

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

Отправляет сообщение указанному MultiplayerParticipant s.

Использует ненадежный метод для отправки сообщения. Этот метод отправки данных быстрее, чем надежная отправка данных, и, если это возможно, ему следует отдавать предпочтение.

ОтправитьUnreliableMessageToOthers 

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

Отправляет сообщение всем участникам, кроме текущего пользователя.

Использует ненадежный метод для отправки сообщения. Этот метод отправки данных быстрее, чем надежная отправка данных, и по возможности ему следует отдавать предпочтение.

Показать плеерселект UI 

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

Асинхронно отображает пользовательский интерфейс выбора игрока, позволяя игроку выбирать других игроков, с которыми он может присоединиться к комнате.

По завершении выбранные игроки будут возвращены через PlayerSelectUICallback .

ПоказатьPlayerSelectUIБлокирование 

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

Блокирующая версия ShowPlayerSelectUI .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

ПоказатьPlayerSelectUIБлокирование 

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

Перегрузка ShowPlayerSelectUIBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

ShowRoomInboxUI 

void ShowRoomInboxUI(
  RoomInboxUICallback callback
)

Асинхронно отображает пользовательский интерфейс папки «Входящие» комнаты, позволяя игроку выбрать приглашение для многопользовательской игры.

По завершении выбранное приглашение возвращается через RoomInboxUIResponse .

ShowRoomInboxUIБлокирование 

RoomInboxUIResponse ShowRoomInboxUIBlocking(
  Timeout timeout
)

Блокирующая версия ShowRoomInboxUI .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

ShowRoomInboxUIБлокирование 

RoomInboxUIResponse ShowRoomInboxUIBlocking()

Перегрузка ShowRoomInboxUIBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

ПоказатьОжиданиеКомнатаUI 

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

Показывает пользовательский интерфейс зала ожидания, в котором отображается статус участников многопользовательской игры, присоединяющихся к этой комнате.

ПоказатьОжиданиеКомнатаUIБлокировка 

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

Блокирующая версия ShowWaitingRoomUI .

Позволяет вызывающему абоненту указать тайм-аут в мс. По истечении указанного времени функция вернет ERROR_TIMEOUT .

ПоказатьОжиданиеКомнатаUIБлокировка 

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

Перегрузка ShowWaitingRoomUIBlocking , которая использует время ожидания по умолчанию 10 лет.