WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIHttpResponse

IID:a2aaaff7-03bd-43b6-b460-94671e288093
Inherits From:nsISupports

Properties

readonly nsIOutputStream bodyOutputStream

A stream to which data appearing in the body of this response should be written.


Methods

void setHeader ( char* name , char* value , PRBool merge ) void setStatusLine ( char* httpVersion , PRUint16 statusCode , char* description ) void write ( char* data )

void setHeader ( char* name , char* value , PRBool merge )

Sets the specified header in this.

Arguments:
name: the name of the header; must match the field-name production per RFC 2616
value: the value of the header; must match the field-value production per RFC 2616
merge: when true, if the given header already exists in this, the values passed to this function will be merged into the existing header, per RFC 2616 header semantics; when false, if the given header already exists in this, it is overwritten with the passed-in values; if the header doesn't exist in this, it is set regardless of the value of this parameter

void setStatusLine ( char* httpVersion , PRUint16 statusCode , char* description )

Sets the status line for this. If this method is never called on this, the status line defaults to "HTTP/", followed by the server's default HTTP version (e.g. "1.1"), followed by " 200 OK".

Arguments:
httpVersion: the HTTP version of this, as a string (e.g. "1.1"); if null, the server default is used
statusCode
description: a human-readable description of code; may be null if no description is desired

void write ( char* data )

Write a string to the response's output stream.

Arguments:
data

References

This interface is passed as an argument to the following methods:

nsIHttpRequestHandler.handle

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com