From b4024938bd6e186a07cf13f75dc3e90beebd501c Mon Sep 17 00:00:00 2001 From: Leorize Date: Fri, 24 Jul 2020 21:15:31 -0500 Subject: [PATCH] BUrlProtocolListener: Update DownloadProgress() docs 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 --- docs/user/net/UrlProtocolListener.dox | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/user/net/UrlProtocolListener.dox b/docs/user/net/UrlProtocolListener.dox index bf0535ef4d..113721f013 100644 --- a/docs/user/net/UrlProtocolListener.dox +++ b/docs/user/net/UrlProtocolListener.dox @@ -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. */ /*!