Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify values returned by wxWebRequest progress methods

Browse Source 
Make it clear which values change and which remain constant.
This commit is contained in:
Vadim Zeitlin
2021-01-12 03:14:18 +01:00
parent a1e0b7e292
commit 3da03b3b7b
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
interface/wx/webrequest.h
View File

@@ -367,13 +367,26 @@ public:
*/ */
State GetState() const; State GetState() const;
/// Returns the number of bytes sent to the server. /**
Returns the number of bytes sent to the server.
This value grows monotonically from 0 to GetBytesExpectedToSend().
*/
wxFileOffset GetBytesSent() const; wxFileOffset GetBytesSent() const;
/// Returns the number of bytes expected to be sent to the server. /**
Returns the total number of bytes expected to be sent to the server.
This value stays unchanged throughout the request duration.
*/
wxFileOffset GetBytesExpectedToSend() const; wxFileOffset GetBytesExpectedToSend() const;
/// Returns the number of bytes received from the server. /**
Returns the number of bytes received from the server.
This value grows monotonically from 0 to GetBytesExpectedToReceive()
(unless it is unknown).
*/
wxFileOffset GetBytesReceived() const; wxFileOffset GetBytesReceived() const;
/** /**