gecko-dev/xpcom/io/nsIPipe.idl
2000-01-05 05:07:46 +00:00

61 lines
2.1 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 nsIAllocator;
interface nsIBufferInputStream;
interface nsIBufferOutputStream;
[scriptable, uuid(686b2d98-56c2-11d3-8cd4-0060b0fc14a3)]
interface nsIPipeObserver : nsISupports {
void onFull(in nsIPipe pipe);
void onWrite(in nsIPipe pipe,
in unsigned long amount);
void onEmpty(in nsIPipe pipe);
void onClose(in nsIPipe pipe);
};
[scriptable, uuid(6c2c0146-56c2-11d3-8cd4-0060b0fc14a3)]
interface nsIPipe : nsISupports {
void initialize(in unsigned long segmentSize,
in unsigned long maxSize,
in nsIPipeObserver observer,
in nsIAllocator segmentAllocator);
readonly attribute nsIBufferInputStream inputStream;
readonly attribute nsIBufferOutputStream outputStream;
attribute nsIPipeObserver observer;
};
%{C++
#define NS_PIPE_DEFAULT_SEGMENT_SIZE 4096
#define NS_PIPE_DEFAULT_BUFFER_SIZE (1024*1024)
extern NS_COM nsresult
NS_NewPipe(nsIBufferInputStream* *inStrResult,
nsIBufferOutputStream* *outStrResult,
nsIPipeObserver* observer = nsnull,
PRUint32 segmentSize = NS_PIPE_DEFAULT_SEGMENT_SIZE,
PRUint32 maxSize = NS_PIPE_DEFAULT_BUFFER_SIZE);
%}