gpg::SnapshotManager

#include <snapshot_manager.h>

获取并设置各种与快照相关的数据。

摘要

如果应用在身份验证时未启用快照(请参阅 GameServices::Builder::EnableSnapshots),则 SnapshotManager 上的大多数方法将失败。

Public 类型

CommitCallback typedef
std::function< void(const CommitResponse &)>
定义接收 CommitResponse 的回调类型。
FetchAllCallback typedef
std::function< void(const FetchAllResponse &)>
定义接收 FetchAllResponse 的回调类型。
MaxSizeCallback typedef
std::function< void(const MaxSizeResponse &)>
定义接收 MaxSizeResponse 的回调类型。
OpenCallback typedef
std::function< void(const OpenResponse &)>
定义接收 OpenResponse 的回调类型。
ReadCallback typedef
std::function< void(const ReadResponse &)>
定义接收 ReadResponse 的回调类型。
SnapshotSelectUICallback typedef
std::function< void(const SnapshotSelectUIResponse &)>
定义可从 ShowSelectUIOperation 接收 SnapshotSelectUIResponse 的回调。

Public 函数

Commit(const SnapshotMetadata & snapshot_metadata, const SnapshotMetadataChange & metadata_change, std::vector< uint8_t > data, CommitCallback callback)
void
异步提交提供给快照的数据,并使用提供的元数据对象更新快照的元数据。
CommitBlocking(const SnapshotMetadata & snapshot_metadata, const SnapshotMetadataChange & metadata_change, std::vector< uint8_t > contents)
同步提交提供给快照的数据,并使用提供的元数据对象更新快照的元数据。
CommitBlocking(Timeout timeout, const SnapshotMetadata & snapshot_metadata, const SnapshotMetadataChange & metadata_change, std::vector< uint8_t > contents)
同步提交提供给快照的数据,并使用提供的元数据对象更新快照的元数据。
Delete(const SnapshotMetadata & snapshot_metadata)
void
删除指定的快照。
FetchAll(FetchAllCallback callback)
void
异步加载当前登录玩家的所有快照数据。
FetchAll(DataSource data_source, FetchAllCallback callback)
void
异步加载当前登录玩家的所有快照数据。
FetchAllBlocking()
同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse
FetchAllBlocking(DataSource data_source)
同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse
FetchAllBlocking(Timeout timeout)
同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse
FetchAllBlocking(DataSource data_source, Timeout timeout)
同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse
GetMaxSize(MaxSizeCallback callback) const
void
异步获取每个快照的最大数据大小和最大封面图片大小(以字节为单位)。
GetMaxSizeBlocking() const
同步获取每个快照的最大数据大小和最大封面图片大小(以字节为单位),直接返回 MaxSizeResponse
GetMaxSizeBlocking(Timeout timeout) const
同步获取每个快照的最大数据大小和最大封面图片大小(以字节为单位),直接返回 MaxSizeResponse
Open(const std::string & file_name, SnapshotConflictPolicy conflict_policy, OpenCallback callback)
void
异步打开具有给定名称的快照。
Open(DataSource data_source, const std::string & file_name, SnapshotConflictPolicy conflict_policy, OpenCallback callback)
void
已弃用。 忽略 data_source。请改用 Open(file_name, conflict_policy, callback)
异步打开具有给定名称的快照。
OpenBlocking(const std::string & file_name, SnapshotConflictPolicy conflict_policy)
同步打开具有给定名称的快照。
OpenBlocking(Timeout timeout, const std::string & file_name, SnapshotConflictPolicy conflict_policy)
同步打开具有给定名称的快照。
OpenBlocking(DataSource data_source, const std::string & file_name, SnapshotConflictPolicy conflict_policy) 已弃用。 忽略 data_source。请改用 OpenBlocking(file_name, conflict_policy)
同步打开具有给定名称的快照。
OpenBlocking(DataSource data_source, Timeout timeout, const std::string & file_name, SnapshotConflictPolicy conflict_policy) 已弃用。 忽略 data_source。请改用 OpenBlocking(timeout, file_name, conflict_policy)
同步打开具有给定名称的快照。
Read(const SnapshotMetadata & snapshot_metadata, ReadCallback callback)
void
异步从磁盘读取快照,并将其复制到内存中。
ReadBlocking(const SnapshotMetadata & snapshot_metadata)
同步从磁盘读取快照,并将其复制到内存中。
ReadBlocking(Timeout timeout, const SnapshotMetadata & snapshot_metadata)
同步从磁盘读取快照并将其复制到内存中。
ResolveConflict(const std::string & conflict_id, const SnapshotMetadata & snapshot_metadata, OpenCallback callback)
void
异步使用提供的快照中的数据解决冲突。
ResolveConflict(const std::string & conflict_id, const SnapshotMetadata & snapshot_metadata, const SnapshotMetadataChange & metadata_change, std::vector< uint8_t > contents, OpenCallback callback)
void
异步使用提供的数据解决冲突。
ResolveConflictBlocking(const std::string & conflict_id, const SnapshotMetadata & snapshot_metadata)
同步使用提供的快照中的数据解决冲突。
ResolveConflictBlocking(const std::string & conflict_id, const SnapshotMetadata & snapshot_metadata, const SnapshotMetadataChange & metadata_change, std::vector< uint8_t > contents)
同步使用提供的数据解决冲突。
ResolveConflictBlocking(Timeout timeout, const std::string & conflict_id, const SnapshotMetadata & snapshot_metadata)
同步使用提供的快照中的数据解决冲突。
ResolveConflictBlocking(Timeout timeout, const std::string & conflict_id, const SnapshotMetadata & snapshot_metadata, const SnapshotMetadataChange & metadata_change, std::vector< uint8_t > contents)
同步使用提供的数据解决冲突。
ShowSelectUIOperation(bool allow_create, bool allow_delete, uint32_t max_snapshots, const std::string & title, SnapshotSelectUICallback callback)
void
异步显示快照 UI,允许玩家选择快照或请求创建新快照。
ShowSelectUIOperationBlocking(Timeout timeout, bool allow_create, bool allow_delete, uint32_t max_snapshots, const std::string & title)
ShowSelectUIOperation 的阻塞版本。
ShowSelectUIOperationBlocking(bool allow_create, bool allow_delete, uint32_t max_snapshots, const std::string & title)
ShowSelectUIOperationBlocking 的重载,使用 10 年的默认超时。

结构体

gpg::SnapshotManager::CommitResponse

保留已更新快照的数据以及响应状态。

gpg::SnapshotManager::FetchAllResponse

保留所有快照的所有数据以及响应状态。

gpg::SnapshotManager::MaxSizeResponse

保留快照数据和快照封面图片的最大大小。

gpg::SnapshotManager::OpenResponse

保留特定请求快照的数据以及响应状态。

gpg::SnapshotManager::ReadResponse

读取快照读取操作返回的响应状态和快照数据。

gpg::SnapshotManager::SnapshotSelectUIResponse

ShowSelectUIOperation 操作的 DataResponseStatus

Public 类型

CommitCallback

std::function< void(const CommitResponse &)> CommitCallback

定义接收 CommitResponse 的回调类型。

此回调类型提供给下面的 Commit(*)ResolveConflict(*) 函数。

FetchAllCallback

std::function< void(const FetchAllResponse &)> FetchAllCallback

定义接收 FetchAllResponse 的回调类型。

此回调类型提供给下面的 FetchAll(*) 函数。

MaxSizeCallback

std::function< void(const MaxSizeResponse &)> MaxSizeCallback

定义接收 MaxSizeResponse 的回调类型。

此回调类型提供给 GetMaxSize

OpenCallback

std::function< void(const OpenResponse &)> OpenCallback

定义接收 OpenResponse 的回调类型。

此回调类型提供给下面的 Open(*) 函数。

ReadCallback

std::function< void(const ReadResponse &)> ReadCallback

定义接收 ReadResponse 的回调类型。

此回调类型提供给下面的 Read(*) 函数。

SnapshotSelectUICallback

std::function< void(const SnapshotSelectUIResponse &)> SnapshotSelectUICallback

定义可从 ShowSelectUIOperation 接收 SnapshotSelectUIResponse 的回调。

Public 函数

Commit

void Commit(
  const SnapshotMetadata & snapshot_metadata,
  const SnapshotMetadataChange & metadata_change,
  std::vector< uint8_t > data,
  CommitCallback callback
)

异步提交提供给快照的数据,并使用提供的元数据对象更新快照的元数据。

操作完成后调用提供的 CommitCallback

CommitBlocking

CommitResponse CommitBlocking(
  const SnapshotMetadata & snapshot_metadata,
  const SnapshotMetadataChange & metadata_change,
  std::vector< uint8_t > contents
)

同步提交提供给快照的数据,并使用提供的元数据对象更新快照的元数据。

CommitBlocking

CommitResponse CommitBlocking(
  Timeout timeout,
  const SnapshotMetadata & snapshot_metadata,
  const SnapshotMetadataChange & metadata_change,
  std::vector< uint8_t > contents
)

同步提交提供给快照的数据,并使用提供的元数据对象更新快照的元数据。

指定 timeout(以毫秒为单位)。

Delete

void Delete(
  const SnapshotMetadata & snapshot_metadata
)

删除指定的快照。

这将在本地和服务器上删除快照的数据。

FetchAll

void FetchAll(
  FetchAllCallback callback
)

异步加载当前登录玩家的所有快照数据。

操作完成后调用提供的 FetchAllCallback。不指定 data_source 使此函数调用等同于调用 FetchAll(DataSource data_source, FetchAllCallback callback),其中 data_source 指定为 CACHE_OR_NETWORK.

FetchAll

void FetchAll(
  DataSource data_source,
  FetchAllCallback callback
)

异步加载当前登录玩家的所有快照数据。

操作完成后调用提供的 FetchAllCallback。将 data_source 指定为 CACHE_OR_NETWORKNETWORK_ONLY

FetchAllBlocking

FetchAllResponse FetchAllBlocking()

同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse

既不指定 data_source 也不指定 timeout 使此函数调用等同于调用 FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout),其中 data_source 指定为 CACHE_OR_NETWORKtimeout 指定为 10 年。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source
)

同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse

data_source 指定为 CACHE_OR_NETWORKNETWORK_ONLY。不指定 timeout 使此函数调用等同于调用 FetchAllBlocking FetchAllResponse(DataSource data_source, Timeout timeout),其中 data_source 为您指定的值,timeout 指定为 10 年。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  Timeout timeout
)

同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse

指定 timeout(以毫秒为单位)。不指定 data_source 使此函数调用等同于调用 FetchAllResponse FetchAllBlocking(DataSource data_source, Timeout timeout),其中 data_source 指定为 CACHE_OR_NETWORKtimeout 包含您指定的值。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source,
  Timeout timeout
)

同步加载当前登录玩家的所有快照数据,直接返回 FetchAllResponse

data_source 指定为 CACHE_OR_NETWORKNETWORK_ONLY。指定 timeout(以毫秒为单位)。

GetMaxSize

void GetMaxSize(
  MaxSizeCallback callback
) const 

异步获取每个快照的最大数据大小和最大封面图片大小(以字节为单位)。

操作完成后调用提供的 MaxSizeCallback

每个快照的最大数据大小保证至少为 3 MB。将来可能会增加。

每个快照封面图片的最大数据大小保证至少为 800 KB。将来可能会增加。

GetMaxSizeBlocking

MaxSizeResponse GetMaxSizeBlocking() const 

同步获取每个快照的最大数据大小和最大封面图片大小(以字节为单位),直接返回 MaxSizeResponse

每个快照的最大数据大小保证至少为 3 MB。将来可能会增加。

每个快照封面图片的最大数据大小保证至少为 800 KB。将来可能会增加。

GetMaxSizeBlocking

MaxSizeResponse GetMaxSizeBlocking(
  Timeout timeout
) const 

同步获取每个快照的最大数据大小和最大封面图片大小(以字节为单位),直接返回 MaxSizeResponse

每个快照的最大数据大小保证至少为 3 MB。将来可能会增加。

每个快照封面图片的最大数据大小保证至少为 800 KB。将来可能会增加。

指定 timeout(以毫秒为单位)。

Open

void Open(
  const std::string & file_name,
  SnapshotConflictPolicy conflict_policy,
  OpenCallback callback
)

异步打开具有给定名称的快照。

如果指定的快照尚不存在,则将创建该快照。操作完成后调用提供的 OpenCallback

快照名称必须是 1 到 100 个非 URL 保留字符(a-z、A-Z、0-9 或符号“-”、“.”、“_”或“~”)组成的字符串。

如果在当前设备加载快照和提交快照之间有另一台设备提交了快照,则可能发生冲突。您必须解决这些冲突。有关冲突的更多详细信息,请参阅上面的 OpenResponse

conflict_policy 可以是以下值之一

SnapshotConflictPolicy::MANUAL - 如果发生冲突,响应的状态为 OpenResponse::VALID_WITH_CONFLICT。您必须使用 SnapshotManager::ResolveConflict 解决冲突。可能会连续出现多次冲突,因此每次调用 Open 时都要检查。这是唯一会看到冲突的策略。其余策略会为您处理冲突解决。此策略确保用户对存档状态的任何更改都不会丢失。

SnapshotConflictPolicy::LONGEST_PLAYTIME - 如果发生冲突,将使用游戏时间最长的快照。如果游戏时长是判断“最佳”存档的合理依据,则此策略是一个不错的选择。请注意,当保存游戏时,您必须使用 SnapshotMetadataChange::Builder::SetPlayedTime(),以便此策略有意义。

SnapshotConflictPolicy::LAST_KNOWN_GOOD - 如果发生冲突,将使用基础快照。如果您的游戏要求快照数据具有稳定性,则此策略是一个合理的选择。此策略确保玩家只能看到没有冲突的写入,这保证了所有客户端的一致性。注意:以前是 SnapshotManager::BASE_WINS

SnapshotConflictPolicy::MOST_RECENTLY_MODIFIED - 如果发生冲突,将使用远程快照。如果您的游戏可以容忍玩家在多个设备上覆盖自己的更改,则此策略是一个合理的选择。由于此策略盲目选择最近的数据,因此玩家的更改可能会丢失。注意:以前是 SnapshotManager::REMOTE_WINS

SnapshotConflictPolicy::HIGHEST_PROGRESS 如果发生冲突,将使用进度值最高的快照。如果进度值相同,则选择上次已知的良好快照。如果您的游戏使用快照的进度值来确定最佳存档,则此策略是一个不错的选择。请注意,当保存游戏时,您必须使用 SnapshotMetadataChange::Builder::SetPlayedTime(),以便此策略有意义。

Open

void Open(
  DataSource data_source,
  const std::string & file_name,
  SnapshotConflictPolicy conflict_policy,
  OpenCallback callback
)

异步打开具有给定名称的快照。

已弃用。 忽略 data_source。请改用 Open(file_name, conflict_policy, callback)

OpenBlocking

OpenResponse OpenBlocking(
  const std::string & file_name,
  SnapshotConflictPolicy conflict_policy
)

同步打开具有给定名称的快照。

如果指定的快照尚不存在,则将创建该快照。

有关更多详细信息,请参阅 Open

OpenBlocking

OpenResponse OpenBlocking(
  Timeout timeout,
  const std::string & file_name,
  SnapshotConflictPolicy conflict_policy
)

同步打开具有给定名称的快照。

如果指定的快照尚不存在,则将创建该快照。

指定 timeout(以毫秒为单位)。

有关更多详细信息,请参阅 Open

OpenBlocking

OpenResponse OpenBlocking(
  DataSource data_source,
  const std::string & file_name,
  SnapshotConflictPolicy conflict_policy
)

同步打开具有给定名称的快照。

已弃用。 忽略 data_source。请改用 OpenBlocking(file_name, conflict_policy)

OpenBlocking

OpenResponse OpenBlocking(
  DataSource data_source,
  Timeout timeout,
  const std::string & file_name,
  SnapshotConflictPolicy conflict_policy
)

同步打开具有给定名称的快照。

已弃用。 忽略 data_source。请改用 OpenBlocking(timeout, file_name, conflict_policy)

Read

void Read(
  const SnapshotMetadata & snapshot_metadata,
  ReadCallback callback
)

异步从磁盘读取快照,并将其复制到内存中。

数据按值传回,以便于修改。每次调用此函数都会进行一次完整读取。这意味着通常最好只读取一次快照。操作完成后调用提供的 ReadCallback

ReadBlocking

ReadResponse ReadBlocking(
  const SnapshotMetadata & snapshot_metadata
)

同步从磁盘读取快照,并将其复制到内存中。

数据按值传回,以便于修改。每次调用此函数都会进行完整读取,因此通常只需读取快照一次。不指定 timeout 使此函数调用等同于调用 ReadBlocking ReadBlocking(Timeout timeout, const SnapshotMetadata& snapshot_metadata),其中 timeout 指定为 10 年。

ReadBlocking

ReadResponse ReadBlocking(
  Timeout timeout,
  const SnapshotMetadata & snapshot_metadata
)

同步从磁盘读取快照并将其复制到内存中。

数据按值传回以便于修改。每次调用都会进行完整读取,因此通常只需读取一次快照。指定 timeout(以毫秒为单位)。

ResolveConflict

void ResolveConflict(
  const std::string & conflict_id,
  const SnapshotMetadata & snapshot_metadata,
  OpenCallback callback
)

异步使用提供的快照中的数据解决冲突。

这将用指定的快照替换服务器上的数据。请注意,此操作本身可能导致冲突,在这种情况下应重复解决冲突。

使用已提交或未通过 Open 打开的快照调用此方法将失败,状态为 BaseStatus::ERROR_INTERNAL

操作完成后调用提供的 OpenCallback

ResolveConflict

void ResolveConflict(
  const std::string & conflict_id,
  const SnapshotMetadata & snapshot_metadata,
  const SnapshotMetadataChange & metadata_change,
  std::vector< uint8_t > contents,
  OpenCallback callback
)

异步使用提供的数据解决冲突。

这将使用指定的元数据更改和 contents 替换服务器上的数据。请注意,此操作本身可能导致冲突,在这种情况下应重复解决冲突。

未包含在元数据更改中的值将被解析为服务器上的当前版本。

请注意,contents 的总大小不得超过 GetMaxSize 提供的 maxDataSize

使用已提交或未通过 Open 打开的快照调用此方法将失败,状态为 BaseStatus::ERROR_INTERNAL

操作完成后调用提供的 OpenCallback

ResolveConflictBlocking

OpenResponse ResolveConflictBlocking(
  const std::string & conflict_id,
  const SnapshotMetadata & snapshot_metadata
)

同步使用提供的快照中的数据解决冲突。

这将用指定的快照替换服务器上的数据。请注意,此操作本身可能导致冲突,在这种情况下应重复解决冲突。

使用已提交或未通过 Open 打开的快照调用此方法将失败,状态为 BaseStatus::ERROR_INTERNAL

ResolveConflictBlocking

OpenResponse ResolveConflictBlocking(
  const std::string & conflict_id,
  const SnapshotMetadata & snapshot_metadata,
  const SnapshotMetadataChange & metadata_change,
  std::vector< uint8_t > contents
)

同步使用提供的数据解决冲突。

这将使用指定的元数据更改和 contents 替换服务器上的数据。请注意,此操作本身可能导致冲突,在这种情况下应重复解决冲突。

未包含在元数据更改中的值将被解析为服务器上的当前版本。

请注意,contents 的总大小不得超过 GetMaxSize 提供的 maxDataSize

使用已提交或未通过 Open 打开的快照调用此方法将失败,状态为 BaseStatus::ERROR_INTERNAL

ResolveConflictBlocking

OpenResponse ResolveConflictBlocking(
  Timeout timeout,
  const std::string & conflict_id,
  const SnapshotMetadata & snapshot_metadata
)

同步使用提供的快照中的数据解决冲突。

这将用指定的快照替换服务器上的数据。请注意,此操作本身可能导致冲突,在这种情况下应重复解决冲突。

使用已提交或未通过 Open 打开的快照调用此方法将失败,状态为 BaseStatus::ERROR_INTERNAL

指定 timeout(以毫秒为单位)。

ResolveConflictBlocking

OpenResponse ResolveConflictBlocking(
  Timeout timeout,
  const std::string & conflict_id,
  const SnapshotMetadata & snapshot_metadata,
  const SnapshotMetadataChange & metadata_change,
  std::vector< uint8_t > contents
)

同步使用提供的数据解决冲突。

这将使用指定的元数据更改和 contents 替换服务器上的数据。请注意,此操作本身可能导致冲突,在这种情况下应重复解决冲突。

未包含在元数据更改中的值将被解析为服务器上的当前版本。

请注意,contents 的总大小不得超过 GetMaxSize 提供的 maxDataSize

使用已提交或未通过 Open 打开的快照调用此方法将失败,状态为 BaseStatus::ERROR_INTERNAL

指定 timeout(以毫秒为单位)。

ShowSelectUIOperation

void ShowSelectUIOperation(
  bool allow_create,
  bool allow_delete,
  uint32_t max_snapshots,
  const std::string & title,
  SnapshotSelectUICallback callback
)

异步显示快照 UI,允许玩家选择快照或请求创建新快照。

操作完成后,选定的快照或新快照请求将通过 SnapshotSelectUICallback 返回。

ShowSelectUIOperationBlocking

SnapshotSelectUIResponse ShowSelectUIOperationBlocking(
  Timeout timeout,
  bool allow_create,
  bool allow_delete,
  uint32_t max_snapshots,
  const std::string & title
)

ShowSelectUIOperation 的阻塞版本。

允许调用方指定超时(以毫秒为单位)。经过指定时间后,函数返回 ERROR_TIMEOUT

ShowSelectUIOperationBlocking

SnapshotSelectUIResponse ShowSelectUIOperationBlocking(
  bool allow_create,
  bool allow_delete,
  uint32_t max_snapshots,
  const std::string & title
)

ShowSelectUIOperationBlocking 的重载,使用 10 年的默认超时。