diff options
Diffstat (limited to 'netwerk/base/nsIMIMEInputStream.idl')
-rw-r--r-- | netwerk/base/nsIMIMEInputStream.idl | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/netwerk/base/nsIMIMEInputStream.idl b/netwerk/base/nsIMIMEInputStream.idl new file mode 100644 index 000000000..82992d939 --- /dev/null +++ b/netwerk/base/nsIMIMEInputStream.idl @@ -0,0 +1,47 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "nsIInputStream.idl" + +/** + * The MIME stream separates headers and a datastream. It also allows + * automatic creation of the content-length header. + */ + +[scriptable, uuid(dcbce63c-1dd1-11b2-b94d-91f6d49a3161)] +interface nsIMIMEInputStream : nsIInputStream +{ + /** + * When true a "Content-Length" header is automatically added to the + * stream. The value of the content-length is automatically calculated + * using the available() method on the data stream. The value is + * recalculated every time the stream is rewinded to the start. + * Not allowed to be changed once the stream has been started to be read. + */ + attribute boolean addContentLength; + + /** + * Adds an additional header to the stream on the form "name: value". May + * not be called once the stream has been started to be read. + * @param name name of the header + * @param value value of the header + */ + void addHeader(in string name, in string value); + + /** + * Sets data-stream. May not be called once the stream has been started + * to be read. + * The cursor of the new stream should be located at the beginning of the + * stream if the implementation of the nsIMIMEInputStream also is used as + * an nsISeekableStream. + * @param stream stream containing the data for the stream + */ + void setData(in nsIInputStream stream); + + /** + * Get the wrapped data stream + */ + readonly attribute nsIInputStream data; +}; |