зеркало из https://github.com/mozilla/gecko-dev.git
Adding some documentation on what exceptions get thrown in what circumstances.
This commit is contained in:
Родитель
338dcd3e52
Коммит
ae855c951d
|
@ -63,10 +63,14 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* Set/get the HTTP request method (default is "GET"). Setter is case
|
* Set/get the HTTP request method (default is "GET"). Setter is case
|
||||||
* insensitive; getter returns an uppercase string.
|
* insensitive; getter returns an uppercase string.
|
||||||
*
|
*
|
||||||
|
* This attribute may only be set before the channel is opened.
|
||||||
|
*
|
||||||
* NOTE: The data for a "POST" or "PUT" request can be configured via
|
* NOTE: The data for a "POST" or "PUT" request can be configured via
|
||||||
* nsIUploadChannel; however, after setting the upload data, it may be
|
* nsIUploadChannel; however, after setting the upload data, it may be
|
||||||
* necessary to set the request method explicitly. The documentation
|
* necessary to set the request method explicitly. The documentation
|
||||||
* for nsIUploadChannel has further details.
|
* for nsIUploadChannel has further details.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_IN_PROGRESS if set after the channel has been opened.
|
||||||
*/
|
*/
|
||||||
attribute ACString requestMethod;
|
attribute ACString requestMethod;
|
||||||
|
|
||||||
|
@ -75,11 +79,15 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* resource from which this channel's URI was obtained (see RFC2616 section
|
* resource from which this channel's URI was obtained (see RFC2616 section
|
||||||
* 14.36).
|
* 14.36).
|
||||||
*
|
*
|
||||||
|
* This attribute may only be set before the channel is opened.
|
||||||
|
*
|
||||||
* NOTE: The channel may silently refuse to set the Referer header if the
|
* NOTE: The channel may silently refuse to set the Referer header if the
|
||||||
* URI does not pass certain security checks (e.g., a "https://" URL will
|
* URI does not pass certain security checks (e.g., a "https://" URL will
|
||||||
* never be sent as the referrer for a plaintext HTTP request). The
|
* never be sent as the referrer for a plaintext HTTP request). The
|
||||||
* implementation is not required to throw an exception when the referrer
|
* implementation is not required to throw an exception when the referrer
|
||||||
* URI is rejected.
|
* URI is rejected.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_IN_PROGRESS if set after the channel has been opened.
|
||||||
*/
|
*/
|
||||||
attribute nsIURI referrer;
|
attribute nsIURI referrer;
|
||||||
|
|
||||||
|
@ -91,6 +99,7 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* "Cache-Control").
|
* "Cache-Control").
|
||||||
*
|
*
|
||||||
* @return the value of the request header.
|
* @return the value of the request header.
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if the header is not set.
|
||||||
*/
|
*/
|
||||||
ACString getRequestHeader(in ACString aHeader);
|
ACString getRequestHeader(in ACString aHeader);
|
||||||
|
|
||||||
|
@ -100,6 +109,8 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* This method allows, for example, the cookies module to add "Cookie"
|
* This method allows, for example, the cookies module to add "Cookie"
|
||||||
* headers to the outgoing HTTP request.
|
* headers to the outgoing HTTP request.
|
||||||
*
|
*
|
||||||
|
* This method may only be called before the channel is opened.
|
||||||
|
*
|
||||||
* @param aHeader
|
* @param aHeader
|
||||||
* The case-insensitive name of the request header to set (e.g.,
|
* The case-insensitive name of the request header to set (e.g.,
|
||||||
* "Cookie").
|
* "Cookie").
|
||||||
|
@ -115,6 +126,9 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* contents of |aValue|.
|
* contents of |aValue|.
|
||||||
*
|
*
|
||||||
* If aValue is empty and aMerge is false, the header will be cleared.
|
* If aValue is empty and aMerge is false, the header will be cleared.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_IN_PROGRESS if called after the channel has been
|
||||||
|
* opened.
|
||||||
*/
|
*/
|
||||||
void setRequestHeader(in ACString aHeader,
|
void setRequestHeader(in ACString aHeader,
|
||||||
in ACString aValue,
|
in ACString aValue,
|
||||||
|
@ -138,6 +152,10 @@ interface nsIHttpChannel : nsIChannel
|
||||||
*
|
*
|
||||||
* This attribute is true by default, though other factors may prevent
|
* This attribute is true by default, though other factors may prevent
|
||||||
* pipelining.
|
* pipelining.
|
||||||
|
*
|
||||||
|
* This attribute may only be set before the channel is opened.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_FAILURE if set after the channel has been opened.
|
||||||
*/
|
*/
|
||||||
attribute boolean allowPipelining;
|
attribute boolean allowPipelining;
|
||||||
|
|
||||||
|
@ -164,6 +182,9 @@ interface nsIHttpChannel : nsIChannel
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the HTTP response code (e.g., 200).
|
* Get the HTTP response code (e.g., 200).
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest).
|
||||||
*/
|
*/
|
||||||
readonly attribute unsigned long responseStatus;
|
readonly attribute unsigned long responseStatus;
|
||||||
|
|
||||||
|
@ -173,6 +194,9 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* NOTE: This returns the raw (possibly 8-bit) text from the server. There
|
* NOTE: This returns the raw (possibly 8-bit) text from the server. There
|
||||||
* are no assumptions made about the charset of the returned text. You
|
* are no assumptions made about the charset of the returned text. You
|
||||||
* have been warned!
|
* have been warned!
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest).
|
||||||
*/
|
*/
|
||||||
readonly attribute ACString responseStatusText;
|
readonly attribute ACString responseStatusText;
|
||||||
|
|
||||||
|
@ -185,6 +209,9 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* Use this attribute to distinguish server error pages from normal pages,
|
* Use this attribute to distinguish server error pages from normal pages,
|
||||||
* instead of comparing the response status manually against the set of
|
* instead of comparing the response status manually against the set of
|
||||||
* valid response codes, if that is required by your application.
|
* valid response codes, if that is required by your application.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest).
|
||||||
*/
|
*/
|
||||||
readonly attribute boolean requestSucceeded;
|
readonly attribute boolean requestSucceeded;
|
||||||
|
|
||||||
|
@ -196,6 +223,10 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* "Set-Cookie").
|
* "Set-Cookie").
|
||||||
*
|
*
|
||||||
* @return the value of the response header.
|
* @return the value of the response header.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest) or if the header is
|
||||||
|
* not set in the response.
|
||||||
*/
|
*/
|
||||||
ACString getResponseHeader(in ACString header);
|
ACString getResponseHeader(in ACString header);
|
||||||
|
|
||||||
|
@ -220,6 +251,11 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* contents of |aValue|.
|
* contents of |aValue|.
|
||||||
*
|
*
|
||||||
* If aValue is empty and aMerge is false, the header will be cleared.
|
* If aValue is empty and aMerge is false, the header will be cleared.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest).
|
||||||
|
* @throws NS_ERROR_ILLEGAL_VALUE if changing the value of this response
|
||||||
|
* header is not allowed.
|
||||||
*/
|
*/
|
||||||
void setResponseHeader(in ACString header,
|
void setResponseHeader(in ACString header,
|
||||||
in ACString value,
|
in ACString value,
|
||||||
|
@ -232,12 +268,18 @@ interface nsIHttpChannel : nsIChannel
|
||||||
*
|
*
|
||||||
* @param aVisitor
|
* @param aVisitor
|
||||||
* the header visitor instance.
|
* the header visitor instance.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest).
|
||||||
*/
|
*/
|
||||||
void visitResponseHeaders(in nsIHttpHeaderVisitor aVisitor);
|
void visitResponseHeaders(in nsIHttpHeaderVisitor aVisitor);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if the server sent a "Cache-Control: no-store" response
|
* Returns true if the server sent a "Cache-Control: no-store" response
|
||||||
* header.
|
* header.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest).
|
||||||
*/
|
*/
|
||||||
boolean isNoStoreResponse();
|
boolean isNoStoreResponse();
|
||||||
|
|
||||||
|
@ -246,6 +288,9 @@ interface nsIHttpChannel : nsIChannel
|
||||||
* no-cache" response header. Equivalent response headers include:
|
* no-cache" response header. Equivalent response headers include:
|
||||||
* "Pragma: no-cache", "Expires: 0", and "Expires" with a date value
|
* "Pragma: no-cache", "Expires: 0", and "Expires" with a date value
|
||||||
* in the past relative to the value of the "Date" header.
|
* in the past relative to the value of the "Date" header.
|
||||||
|
*
|
||||||
|
* @throws NS_ERROR_NOT_AVAILABLE if called before the response
|
||||||
|
* has been received (before onStartRequest).
|
||||||
*/
|
*/
|
||||||
boolean isNoCacheResponse();
|
boolean isNoCacheResponse();
|
||||||
};
|
};
|
||||||
|
|
Загрузка…
Ссылка в новой задаче