MGL リーダーボードサーバ [詳解]

#include <mgl_leaderboard_server.h>

MGL::Leaderboard::Server の継承関係図

公開型
enum class	State : uint8_t { NotReady , Ready , FetchEntryData , ReportScore , UploadClipData , DownloadClipData }
	ステート [詳解]

公開メンバ関数
	Server () noexcept
	コンストラクタ

bool	Initialize (STL::unique_ptr< ServerDelegate > &delegate) noexcept
	初期化処理

bool	ReportScore (Identifier identifier, uint64_t score, const OptionDataArray &options) noexcept
	スコアの送信

bool	FetchEntryData (Identifier identifier, uint32_t startRank, uint32_t requestSize, PlayerScope playerScope) noexcept
	エントリデータを取得

bool	FetchEntryDataAroundUser (Identifier identifier, uint32_t requestSize, PlayerScope playerScope) noexcept
	プレイヤーの順位を中心にエントリデータを取得

bool	UploadClipData (Identifier identifier, const ClipData &clipData) noexcept
	クリップデータの送信

bool	DownloadClipData (uint64_t clipID) noexcept
	クリップデータのダウンロード

const FetchResults &	GetFetchedData () const noexcept
	エントリ取得結果を取得

const ReportResults &	GetReportResults () const noexcept
	送信結果を取得

const ClipData &	GetClipData () const noexcept
	ダウンロードしたクリップデータを取得

ClipData::ErrorType	GetClipDataUploadResults () const noexcept
	クリップデータのアップロード結果を取得

constexpr bool	IsProcessing () const noexcept
	処理中かどうかを取得

constexpr State	GetState () const noexcept
	現在のステートを取得

基底クラス MGL::SharedSingleton< Server > に属する継承公開メンバ関数
	SharedSingleton (const SharedSingleton &) noexcept=delete

	SharedSingleton (SharedSingleton &&) noexcept=delete

SharedSingleton &	operator= (const SharedSingleton &) noexcept=delete

SharedSingleton &	operator= (SharedSingleton &&) noexcept=delete

静的公開メンバ関数
static STL::unique_ptr< Server > &	GetInstanceRef () noexcept
	インスタンスの取得

基底クラス MGL::SharedSingleton< Server > に属する継承静的公開メンバ関数
static Server &	CreateInstance (Args... args) noexcept
	インスタンスの生成

static Server &	GetInstance () noexcept
	インスタンスの取得

static void	DestroyInstance () noexcept
	インスタンスの破棄

static bool	HasInstance () noexcept
	有効なインスタンスを保持しているかを取得

詳解

MGL リーダーボードサーバ

列挙型メンバ詳解

◆ State

enum class MGL::Leaderboard::Server::State : uint8_t

strong

ステート

列挙値
NotReady	準備できていない
Ready	準備完了
FetchEntryData	エントリ取得中
ReportScore	スコア送信中
UploadClipData	クリップデータをアップロード中
DownloadClipData	クリップデータをダウンロード中

関数詳解

◆ DownloadClipData()

bool MGL::Leaderboard::Server::DownloadClipData ( uint64_t clipID )

noexcept

クリップデータのダウンロード

引数

[in] clipID クリップデータの識別子

戻り値

true	成功
false	失敗

◆ FetchEntryData()

bool MGL::Leaderboard::Server::FetchEntryData	(	Identifier	identifier,
		uint32_t	startRank,
		uint32_t	requestSize,
		PlayerScope	playerScope )

noexcept

エントリデータを取得

引数

[in]	identifier	リーダーボードの識別子
[in]	startRank	取得する最初の順位
[in]	requestSize	取得するエントリ数
[in]	playerScope	取得するプレイヤーのスコープ

戻り値

true	成功
false	失敗

◆ FetchEntryDataAroundUser()

bool MGL::Leaderboard::Server::FetchEntryDataAroundUser	(	Identifier	identifier,
		uint32_t	requestSize,
		PlayerScope	playerScope )

noexcept

プレイヤーの順位を中心にエントリデータを取得

引数

[in]	identifier	リーダーボードの識別子
[in]	requestSize	取得するエントリ数
[in]	playerScope	取得するプレイヤーのスコープ

戻り値

true	成功
false	失敗

◆ GetClipData()

const ClipData & MGL::Leaderboard::Server::GetClipData ( ) const

inlinenodiscardnoexcept

ダウンロードしたクリップデータを取得

戻り値: クリップデータ

◆ GetClipDataUploadResults()

ClipData::ErrorType MGL::Leaderboard::Server::GetClipDataUploadResults ( ) const

inlinenodiscardnoexcept

クリップデータのアップロード結果を取得

戻り値: クリップデータのエラータイプ．成功している場合はErrorType::None

◆ GetFetchedData()

const FetchResults & MGL::Leaderboard::Server::GetFetchedData ( ) const

inlinenodiscardnoexcept

エントリ取得結果を取得

戻り値: 取得結果

◆ GetInstanceRef()

STL::unique_ptr< Server > & MGL::Leaderboard::Server::GetInstanceRef ( )

staticnoexcept

インスタンスの取得

戻り値: インスタンスの参照

◆ GetReportResults()

const ReportResults & MGL::Leaderboard::Server::GetReportResults ( ) const

inlinenodiscardnoexcept

送信結果を取得

戻り値: 送信結果

◆ GetState()

State MGL::Leaderboard::Server::GetState ( ) const

inlinenodiscardconstexprnoexcept

現在のステートを取得

戻り値: 現在のステート

◆ Initialize()

bool MGL::Leaderboard::Server::Initialize ( STL::unique_ptr< ServerDelegate > & delegate )

noexcept

初期化処理

引数

[in] delegate デリゲートクラス

戻り値

true	成功
false	失敗

◆ IsProcessing()

bool MGL::Leaderboard::Server::IsProcessing ( ) const

inlinenodiscardconstexprnoexcept

処理中かどうかを取得

戻り値

true	処理中
false	処理中でない

◆ ReportScore()

bool MGL::Leaderboard::Server::ReportScore	(	Identifier	identifier,
		uint64_t	score,
		const OptionDataArray &	options )

noexcept

スコアの送信

引数

[in]	identifier	リーダーボードの識別子
[in]	score	送信するスコア
[in]	options	送信するオプションデータ

戻り値

true	成功
false	失敗

◆ UploadClipData()

bool MGL::Leaderboard::Server::UploadClipData	(	Identifier	identifier,
		const ClipData &	clipData )

noexcept

クリップデータの送信

引数

[in]	identifier	リーダーボードの識別子
[in]	clipData	送信するクリップデータ

戻り値

true	成功
false	失敗

このクラス詳解は次のファイルから抽出されました:

/Users/acerola/work/mgl-work/mgl/include/mgl/leaderboard/mgl_leaderboard_server.h
/Users/acerola/work/mgl-work/mgl/src/leaderboard/mgl_leaderboard_server.cc

公開型

公開メンバ関数

静的公開メンバ関数

詳解

列挙型メンバ詳解

◆ State

関数詳解

◆ DownloadClipData()

◆ FetchEntryData()

◆ FetchEntryDataAroundUser()

◆ GetClipData()

◆ GetClipDataUploadResults()

◆ GetFetchedData()

◆ GetInstanceRef()

◆ GetReportResults()

◆ GetState()

◆ Initialize()

◆ IsProcessing()

◆ ReportScore()

◆ UploadClipData()