Back to index

lightning-sunbird  0.9+nobinonly
nsIByteBuffer.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 #ifndef nsIByteBuffer_h___
00039 #define nsIByteBuffer_h___
00040 
00041 #include "nscore.h"
00042 #include "nsISupports.h"
00043 
00044 class nsIInputStream;
00045 
00046 #define NS_IBYTE_BUFFER_IID    \
00047 { 0xe4a6e4b0, 0x93b4, 0x11d1, \
00048   {0x89, 0x5b, 0x00, 0x60, 0x08, 0x91, 0x1b, 0x81} }
00049 #define NS_IBYTEBUFFER_IID    \
00050 { 0xe4a6e4b0, 0x93b4, 0x11d1, \
00051   {0x89, 0x5b, 0x00, 0x60, 0x08, 0x91, 0x1b, 0x81} }
00052 #define NS_BYTEBUFFER_CONTRACTID "@mozilla.org/byte-buffer;1"
00053 #define NS_BYTEBUFFER_CLASSNAME "Byte Buffer"
00054 
00056 class nsIByteBuffer : public nsISupports {
00057 public:
00058   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IBYTEBUFFER_IID)
00059 
00060   NS_IMETHOD Init(PRUint32 aBufferSize) = 0;
00061 
00063   NS_IMETHOD_(PRUint32) GetLength(void) const = 0;
00064 
00066   NS_IMETHOD_(PRUint32) GetBufferSize(void) const = 0;
00067 
00069   NS_IMETHOD_(char*) GetBuffer(void) const = 0;
00070 
00072   NS_IMETHOD_(PRBool) Grow(PRUint32 aNewSize) = 0;
00073 
00076   NS_IMETHOD_(PRInt32) Fill(nsresult* aErrorCode, nsIInputStream* aStream,
00077                             PRUint32 aKeep) = 0;
00078 };
00079 
00080 #define NS_BYTEBUFFER_CID                            \
00081 { /* a49d5280-0d6b-11d3-9331-00104ba0fd40 */         \
00082     0xa49d5280,                                      \
00083     0x0d6b,                                          \
00084     0x11d3,                                          \
00085     {0x93, 0x31, 0x00, 0x10, 0x4b, 0xa0, 0xfd, 0x40} \
00086 }
00087 
00089 extern NS_COM nsresult 
00090 NS_NewByteBuffer(nsIByteBuffer** aInstancePtrResult,
00091                  nsISupports* aOuter,
00092                  PRUint32 aBufferSize = 0);
00093 
00094 #endif /* nsIByteBuffer_h___ */
00095