Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

BUrlProtocolListener: Update DownloadProgress() docs

Browse Source 
Updated to reflect the consistency changes done to
BUrlProtocolListener::DownloadProgress().

Change-Id: I05cfac647507a3fff294900a107293b85eff60fb
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3079
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
This commit is contained in:
Leorize 2020-07-24 21:15:31 -05:00 committed by waddlesplash
parent 7bac04e684
commit b4024938bd
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/user/net/UrlProtocolListener.dox
View File

@ -130,16 +130,19 @@
/*!
\fn virtual void BUrlProtocolListener::DownloadProgress(BUrlRequest* caller,
ssize_t bytesReceived, ssize_t bytesTotal)
\brief Called each time a block of data is received.
\brief Called each time a block of data is downloaded.
This callback will be called after DataReceived().
This callback will usually be called after DataReceived().
\b Frequency: Once or more
\param caller The BUrlRequest that invoked this callback.
\param bytesReceived Number of data bytes received.
\param bytesTotal Total number of data bytes expected. This value is not
guaranteed to be meaningful.
\param bytesReceived Number of data bytes received. This is the number of
bytes received prior to any processing and can be smaller than the
size of the data block sent to DataReceived() as the transport might
be compressed.
\param bytesTotal Total number of data bytes expected. \c 0 will be passed
if the total number of data bytes is not available.
*/
/*!