gecko-dev/xpcom/io/nsIPipe.idl

72 строки
2.7 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* The contents of this file are subject to the Netscape Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#include "nsISupports.idl"
interface nsIPipe;
interface nsIMemory;
interface nsIInputStream;
interface nsIOutputStream;
[scriptable, uuid(f4211abc-61b3-11d4-9877-00c04fa0cf4a)]
interface nsIPipe : nsISupports {
void initialize(in unsigned long segmentSize,
in unsigned long maxSize,
in boolean nonBlockingInput,
in boolean nonBlockingOutput,
in nsIMemory segmentAllocator);
readonly attribute nsIInputStream inputStream;
readonly attribute nsIOutputStream outputStream;
};
[scriptable, uuid(8C39EF62-F7C9-11d4-98F5-001083010E9B)]
interface nsISearchableInputStream : nsISupports {
/**
* Searches for a string in the input stream. Since the stream has a notion
* of EOF, it is possible that the string may at some time be in the
* buffer, but is is not currently found up to some offset. Consequently,
* both the found and not found cases return an offset:
* if found, return offset where it was found
* if not found, return offset of the first byte not searched
* In the case the stream is at EOF and the string is not found, the first
* byte not searched will correspond to the length of the buffer.
*/
void search(in string forString,
in boolean ignoreCase,
out boolean found,
out unsigned long offsetSearchedTo);
};
%{C++
#define NS_PIPE_DEFAULT_SEGMENT_SIZE 4096
#define NS_PIPE_DEFAULT_BUFFER_SIZE (1024*1024)
extern NS_COM nsresult
NS_NewPipe(nsIInputStream* *inStrResult,
nsIOutputStream* *outStrResult,
PRUint32 segmentSize = NS_PIPE_DEFAULT_SEGMENT_SIZE,
PRUint32 maxSize = NS_PIPE_DEFAULT_BUFFER_SIZE,
PRBool nonBlockingInput = PR_FALSE,
PRBool nonBlockingOutput = PR_FALSE,
nsIMemory* segmentAllocator = nsnull);
%}