274218 - nsIStreamListener documentation unclear about offset parameter

Status: RESOLVED FIXED

(Core :: Networking, enhancement)

Description

[Christian :Biesinger (don't email me, ping me on IRC)]

58      * @param aOffset current stream position

this does not seem to make it clear what the value should be when a channel impl
creates a new stream for each ODA call - for each such ODA, the offset in the
stream would be 0 (since it's a newly created stream). But data has been
transferred already - isn't this argument supposed to be, basically, "amount of
bytes transferred already"?

Comment 1

[Darin Fisher]

> isn't this argument supposed to be, basically, "amount of bytes transferred 
> already"

yes, that is how i have always interpreted the parameter.

Comment 2

[Christian :Biesinger (don't email me, ping me on IRC)]

Attachment: patch

comment-change only, so it's safe for the branch

Comment 3

[Darin Fisher]

Comment on attachment 229908 [details] [diff] [review]
patch

Please add a comment about what happens to offset for large files.  I think the answer is that when it hits PR_UINT32_MAX, it stays there and does not roll-over.

Comment 4

[Christian :Biesinger (don't email me, ping me on IRC)]

Attachment: final patch

yep, that's the behaviour of the input stream pump, at least on trunk.

Comment 5

[Christian :Biesinger (don't email me, ping me on IRC)]

HEAD:
Checking in nsIStreamListener.idl;
/cvsroot/mozilla/netwerk/base/public/nsIStreamListener.idl,v  <--  nsIStreamListener.idl
new revision: 1.21; previous revision: 1.20
done

MOZILLA_1_8_BRANCH:
Checking in nsIStreamListener.idl;
/cvsroot/mozilla/netwerk/base/public/nsIStreamListener.idl,v  <--  nsIStreamListener.idl
new revision: 1.20.8.1; previous revision: 1.20
done