Mozilla

• About
• Developers
• Store
• Support
• Products

nsIUploadChannel

---

This interface is implemented by channels that wish to support the notion of uploading a data stream. The upload stream must be set prior to the invocation of asyncOpen on the channel. The interface is scriptable.

Methods

setUploadStream

Sets a stream to be uploaded by this channel.

Most implementations of this interface require that the stream:
(1) implement threadsafe addRef and release
(2) implement nsIInputStream::readSegments
(3) implement nsISeekableStream::seek.

Note: The history here is that some streams (from plugins) already have header (e.g., Content-Type and Content-Length) information prepended to the stream and other streams (from clients such as Mozilla Composer or other uploading applications that want to upload data streams without any knowledge of protocol specifications) don't. The decision was that both types of streams should be supported. For this reason, there is a special meaning for the aContentType parameter (see below).

Syntax:

void nsIUploadChannel::setUploadStream(
	in nsIInputStream aStream, in ACString aContentType, 
	in long aContentLength)  

Parameters:

aStream: The stream to be uploaded by this channel.

aContentType: If aContentType is empty, the protocol will assume that no content headers are to be added to the uploaded stream and that any required headers are already encoded in the stream. In the case of http:, if this parameter is non-empty, then its value will replace any existing Content-Type header on the HTTP request. In the case of ftp: and file:, this parameter is ignored.

aContentLength: A value of -1 indicates that the length of the stream should be determined by calling the stream's available method.

nsresult:

NS_OK if successful.

Attributes

readonly attribute nsIInputStream nsIUploadChannel::uploadStream

Gets the stream (to be) uploaded by this channel.

• Site Map
• Security Updates
• Contact Us
• Donate

Portions of this content are © 1998–2009 by individual mozilla.org contributors; content available under a Creative Commons license | Details.

Last modified May 7, 2003 Document History