VirtualBox

source: vbox/trunk/src/libs/xpcom18a4/xpcom/ds/nsIByteBuffer.h@ 62375

Last change on this file since 62375 was 1, checked in by vboxsync, 55 years ago

import

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.6 KB
Line 
1/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2/* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either of the GNU General Public License Version 2 or later (the "GPL"),
26 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38#ifndef nsIByteBuffer_h___
39#define nsIByteBuffer_h___
40
41#include "nscore.h"
42#include "nsISupports.h"
43
44class nsIInputStream;
45
46#define NS_IBYTE_BUFFER_IID \
47{ 0xe4a6e4b0, 0x93b4, 0x11d1, \
48 {0x89, 0x5b, 0x00, 0x60, 0x08, 0x91, 0x1b, 0x81} }
49#define NS_IBYTEBUFFER_IID \
50{ 0xe4a6e4b0, 0x93b4, 0x11d1, \
51 {0x89, 0x5b, 0x00, 0x60, 0x08, 0x91, 0x1b, 0x81} }
52#define NS_BYTEBUFFER_CONTRACTID "@mozilla.org/byte-buffer;1"
53#define NS_BYTEBUFFER_CLASSNAME "Byte Buffer"
54
55/** Interface to a buffer that holds bytes */
56class nsIByteBuffer : public nsISupports {
57public:
58 NS_DEFINE_STATIC_IID_ACCESSOR(NS_IBYTEBUFFER_IID)
59
60 NS_IMETHOD Init(PRUint32 aBufferSize) = 0;
61
62 /** @return length of buffer, i.e. how many bytes are currently in it. */
63 NS_IMETHOD_(PRUint32) GetLength(void) const = 0;
64
65 /** @return number of bytes allocated in the buffer */
66 NS_IMETHOD_(PRUint32) GetBufferSize(void) const = 0;
67
68 /** @return the buffer */
69 NS_IMETHOD_(char*) GetBuffer(void) const = 0;
70
71 /** Grow buffer to aNewSize bytes. */
72 NS_IMETHOD_(PRBool) Grow(PRUint32 aNewSize) = 0;
73
74 /** Fill the buffer with data from aStream. Don't grow the buffer, only
75 * read until length of buffer equals buffer size. */
76 NS_IMETHOD_(PRInt32) Fill(nsresult* aErrorCode, nsIInputStream* aStream,
77 PRUint32 aKeep) = 0;
78};
79
80#define NS_BYTEBUFFER_CID \
81{ /* a49d5280-0d6b-11d3-9331-00104ba0fd40 */ \
82 0xa49d5280, \
83 0x0d6b, \
84 0x11d3, \
85 {0x93, 0x31, 0x00, 0x10, 0x4b, 0xa0, 0xfd, 0x40} \
86}
87
88/** Create a new byte buffer using the given buffer size. */
89extern NS_COM nsresult
90NS_NewByteBuffer(nsIByteBuffer** aInstancePtrResult,
91 nsISupports* aOuter,
92 PRUint32 aBufferSize = 0);
93
94#endif /* nsIByteBuffer_h___ */
95
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette