Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIUploadChannel Interface Reference

nsIUploadChannel More...

import "nsIUploadChannel.idl";

Inheritance diagram for nsIUploadChannel:
Inheritance graph
Collaboration diagram for nsIUploadChannel:
Collaboration graph

List of all members.

Public Member Functions

void setUploadStream (in nsIInputStream aStream, in ACString aContentType, in long aContentLength)
 Sets a stream to be uploaded by this channel.

Public Attributes

readonly attribute nsIInputStream uploadStream
 Get the stream (to be) uploaded by this channel.

Detailed Description


A channel may optionally implement this interface if it supports the notion of uploading a data stream. The upload stream may only be set prior to the invocation of asyncOpen on the channel.


Definition at line 52 of file nsIUploadChannel.idl.

Member Function Documentation

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

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

History here is that we need to support both streams that already have headers (e.g., Content-Type and Content-Length) information prepended to the stream (by plugins) as well as clients (composer, uploading application) that want to upload data streams without any knowledge of protocol specifications. For this reason, we have a special meaning for the aContentType parameter (see below).

aStreamThe stream to be uploaded by this channel.
aContentTypeIf 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.
aContentLengthA value of -1 indicates that the length of the stream should be determined by calling the stream's |available| method.

Member Data Documentation

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

Definition at line 89 of file nsIUploadChannel.idl.

The documentation for this interface was generated from the following file: