Back to index

lightning-sunbird  0.9+nobinonly
nsIPipe.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsIAsyncInputStream.idl"
00039 #include "nsIAsyncOutputStream.idl"
00040 
00041 interface nsIMemory;
00042 
00071 [scriptable, uuid(f4211abc-61b3-11d4-9877-00c04fa0cf4a)]
00072 interface nsIPipe : nsISupports
00073 {
00077     void init(in boolean nonBlockingInput,
00078               in boolean nonBlockingOutput,
00079               in unsigned long segmentSize,
00080               in unsigned long segmentCount,
00081               in nsIMemory segmentAllocator);
00082 
00086     readonly attribute nsIAsyncInputStream inputStream;
00087 
00091     readonly attribute nsIAsyncOutputStream outputStream;
00092 };
00093 
00098 [scriptable, uuid(8C39EF62-F7C9-11d4-98F5-001083010E9B)] 
00099 interface nsISearchableInputStream : nsISupports
00100 {
00111     void search(in string forString, 
00112                 in boolean ignoreCase, 
00113                 out boolean found,
00114                 out unsigned long offsetSearchedTo);
00115 };
00116 
00117 %{C++
00118 
00148 extern NS_COM nsresult
00149 NS_NewPipe2(nsIAsyncInputStream **pipeIn,
00150             nsIAsyncOutputStream **pipeOut,
00151             PRBool nonBlockingInput = PR_FALSE,
00152             PRBool nonBlockingOutput = PR_FALSE,
00153             PRUint32 segmentSize = 0,
00154             PRUint32 segmentCount = 0,
00155             nsIMemory *segmentAlloc = nsnull);
00156 
00185 inline nsresult
00186 NS_NewPipe(nsIInputStream **pipeIn,
00187            nsIOutputStream **pipeOut,
00188            PRUint32 segmentSize = 0,
00189            PRUint32 maxSize = 0,
00190            PRBool nonBlockingInput = PR_FALSE,
00191            PRBool nonBlockingOutput = PR_FALSE,
00192            nsIMemory *segmentAlloc = nsnull)
00193 {
00194     PRUint32 segmentCount;
00195     if (segmentSize == 0)
00196         segmentCount = 0; // use default
00197     else
00198         segmentCount = maxSize / segmentSize;
00199 
00200     nsIAsyncInputStream *in;
00201     nsIAsyncOutputStream *out;
00202     nsresult rv = NS_NewPipe2(&in, &out, nonBlockingInput, nonBlockingOutput,
00203                               segmentSize, segmentCount, segmentAlloc);
00204     if (NS_FAILED(rv)) return rv;
00205 
00206     *pipeIn = in;
00207     *pipeOut = out;
00208     return NS_OK;
00209 }
00210 
00211 %}