Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-12 04:45:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

394242 improve the comments on some necko APIs r+sr+a=bz

Browse Source
This commit is contained in:
cbiesinger@gmx.at 2007-08-31 13:23:31 -07:00
parent 63b56fc006
commit d57efe93ed
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
netwerk/base/public/nsIChannel.idl
View File

@ -95,7 +95,7 @@ interface nsIChannel : nsIRequest
* callbacks do not supply the requested interface.
*
* Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt,
* and nsIAuthPrompt.
* and nsIAuthPrompt/nsIAuthPrompt2.
*
* When the channel is done, it must not continue holding references to
* this object.
@ -192,6 +192,9 @@ interface nsIChannel : nsIRequest
* keeping itself alive until it has called onStopRequest on aListener or
* called onChannelRedirect.
*
* Implementations are allowed to synchronously add themselves to the
* associated load group (if any).
*
* NOTE: Implementations should throw NS_ERROR_ALREADY_OPENED if the
* channel is reopened.
*

12
netwerk/base/public/nsIRequest.idl
View File

@ -83,6 +83,13 @@ interface nsIRequest : nsISupports
* be passed. The error passed in will become the value of the
* status attribute.
*
* Implementations must not send any notifications (e.g. via
* nsIRequestObserver) synchronously from this function. Similarly,
* removal from the load group (if any) must also happen asynchronously.
*
* Requests that use nsIStreamListener must not call onDataAvailable
* anymore after cancel has been called.
*
* @param aStatus the reason for canceling this request.
*
* NOTE: most nsIRequest implementations expect aStatus to be a
@ -96,7 +103,10 @@ interface nsIRequest : nsISupports
* Suspends the current request. This may have the effect of closing
* any underlying transport (in order to free up resources), although
* any open streams remain logically opened and will continue delivering
* data when the transport is resumed.
* data when the transport is resumed.
*
* Calling cancel() on a suspended request must not send any
* notifications (such as onstopRequest) until the request is resumed.
*
* NOTE: some implementations are unable to immediately suspend, and
* may continue to deliver events already posted to an event queue. In