Back to index

enigmail  1.4.3
nsIIPCBuffer.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public
00005  * License Version 1.1 (the "MPL"); you may not use this file
00006  * except in compliance with the MPL. You may obtain a copy of
00007  * the MPL at http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the MPL is distributed on an "AS
00010  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
00011  * implied. See the MPL for the specific language governing
00012  * rights and limitations under the MPL.
00013  *
00014  * The Original Code is protoZilla.
00015  *
00016  * The Initial Developer of the Original Code is Ramalingam Saravanan.
00017  * Portions created by Ramalingam Saravanan <svn@xmlterm.org> are
00018  * Copyright (C) 2000 Ramalingam Saravanan. All Rights Reserved.
00019  *
00020  * Contributor(s):
00021  * Patrick Brunschwig <patrick@mozilla-enigmail.org>
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  * ***** END LICENSE BLOCK ***** */
00035 
00036 #include "nsIPipeListener.idl"
00037 
00038 interface nsIURI;
00039 interface nsIRunnable;
00040 interface nsIRequestObserver;
00041 
00042 %{C++
00043 #define NS_IPCBUFFER_CLASSNAME "IPC Buffer"
00044 #define NS_IPCBUFFER_CONTRACTID "@mozilla.org/ipc/ipc-buffer;1"
00045 
00046 #define NS_IPCBUFFER_CID                         \
00047 { /* 8431e1c1-7ab1-11d4-8f02-a06008948af5 */     \
00048    0x8431e1c1, 0x7ab1, 0x11d4,                   \
00049 {0x8f, 0x02, 0xa0, 0x60, 0x08, 0x94, 0x8a, 0xf5} }
00050 
00051 %}
00052 
00053 /* nsIIPCBuffer is an interface to a byte buffer.
00054  * It is thread-safe, i.e.,it may be called from any thread. It uses a
00055  * monitor to ensure data integrity.
00056  */
00057 
00058 [scriptable, uuid(8431e1c0-7ab1-11d4-8f02-a06008948af5)]
00059 interface nsIIPCBuffer : nsIPipeListener
00060 {
00073   void open(in long maxBytes, in boolean overflowFile);
00074 
00090   void openURI(in nsIURI aURI,
00091                in long maxBytes,
00092                in boolean synchronous,
00093                in nsIRequestObserver observer,
00094                in nsISupports ctxt,
00095                in boolean overflowFile);
00096 
00102   nsIInputStream openInputStream();
00103 
00108   string getData();
00109 
00113   readonly attribute boolean stopped;
00114 
00118   readonly attribute unsigned long totalBytes;
00119 };
00120 
00121