非同期ダウンロードを管理するクラス More...

#include <AsyncHTTPTask.hpp>

Public Member Functions
SIV3D_NODISCARD_CXX20	AsyncHTTPTask ()
	デフォルトコンストラクタ More...

bool	isEmpty () const
	管理するダウンロードが無いかを返します。 More...

	operator bool () const
	管理するダウンロードがあるかを返します。 More...

bool	isReady () const
	ダウンロードが終了したときに 1 度だけ true を返します。 More...

void	cancel ()
	ダウンロードを中断します。 More...

HTTPAsyncStatus	getStatus () const
	ダウンロードの進行状況を返します。 More...

HTTPProgress	getProgress () const
	ダウンロードの進捗を返します。 More...

bool	isDownloading () const
	ダウンロードが進行中であるかを返します。 More...

bool	isFailed () const
	ダウンロードが失敗したかを返します。 More...

bool	isCanceled () const
	ダウンロードが中断されたかを返します。 More...

bool	isSucceeded () const
	ダウンロードが成功したかを返します。 More...

const HTTPResponse &	getResponse ()
	HTTP レスポンスを返します。 More...

Friends
AsyncHTTPTask	SimpleHTTP::SaveAsync (URLView url, FilePathView filePath)

Detailed Description

非同期ダウンロードを管理するクラス

Constructor & Destructor Documentation

◆ AsyncHTTPTask()

SIV3D_NODISCARD_CXX20 s3d::AsyncHTTPTask::AsyncHTTPTask ( )

デフォルトコンストラクタ

Member Function Documentation

◆ cancel()

void s3d::AsyncHTTPTask::cancel ( )

ダウンロードを中断します。

◆ getProgress()

HTTPProgress s3d::AsyncHTTPTask::getProgress ( ) const

ダウンロードの進捗を返します。

Returns: ダウンロードの進捗

◆ getResponse()

const HTTPResponse& s3d::AsyncHTTPTask::getResponse ( )

HTTP レスポンスを返します。

Returns: HTTP レスポンス

◆ getStatus()

HTTPAsyncStatus s3d::AsyncHTTPTask::getStatus ( ) const

ダウンロードの進行状況を返します。

Returns: ダウンロードの進行状況

◆ isCanceled()

bool s3d::AsyncHTTPTask::isCanceled ( ) const

ダウンロードが中断されたかを返します。

Remarks: getStatus() == HTTPAsyncStatus::Canceled と同じです。

Returns: ダウンロードが中断された場合 true, それ以外の場合は false

◆ isDownloading()

bool s3d::AsyncHTTPTask::isDownloading ( ) const

ダウンロードが進行中であるかを返します。

Remarks: getStatus() == HTTPAsyncStatus::Downloading と同じです。

Returns: ダウンロードが進行中である場合 true, それ以外の場合は false

◆ isEmpty()

bool s3d::AsyncHTTPTask::isEmpty ( ) const

管理するダウンロードが無いかを返します。

Returns: 管理するダウンロードが無い場合 true, それ以外の場合は false

◆ isFailed()

bool s3d::AsyncHTTPTask::isFailed ( ) const

ダウンロードが失敗したかを返します。

Remarks: getStatus() == HTTPAsyncStatus::Failed と同じです。

Returns: ダウンロードが失敗した場合 true, それ以外の場合は false

◆ isReady()

bool s3d::AsyncHTTPTask::isReady ( ) const

ダウンロードが終了したときに 1 度だけ true を返します。

Returns: ダウンロードが終了した場合 true, それ以外の場合は false

◆ isSucceeded()

bool s3d::AsyncHTTPTask::isSucceeded ( ) const

ダウンロードが成功したかを返します。

Remarks: getStatus() == HTTPAsyncStatus::Succeeded と同じです。

Returns: ダウンロードが成功した場合 true, それ以外の場合は false

◆ operator bool()

s3d::AsyncHTTPTask::operator bool ( ) const

explicit

管理するダウンロードがあるかを返します。

Returns: 管理するダウンロードがある場合 true, それ以外の場合は false

Friends And Related Function Documentation

◆ SimpleHTTP::SaveAsync

AsyncHTTPTask SimpleHTTP::SaveAsync	(	URLView	url,
		FilePathView	filePath
	)

friend

The documentation for this class was generated from the following file:

OpenSiv3D/Siv3D/include/Siv3D/AsyncHTTPTask.hpp

Public Member Functions

Friends