Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIByteBuffer Class Reference

Interface to a buffer that holds bytes. More...

#include <nsIByteBuffer.h>

Inheritance diagram for nsIByteBuffer:
Inheritance graph
[legend]
Collaboration diagram for nsIByteBuffer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD Init (PRUint32 aBufferSize)=0
 NS_IMETHOD_ (PRUint32) GetLength(void) const =0
 NS_IMETHOD_ (PRUint32) GetBufferSize(void) const =0
 NS_IMETHOD_ (char *) GetBuffer(void) const =0
 NS_IMETHOD_ (PRBool) Grow(PRUint32 aNewSize)=0
 Grow buffer to aNewSize bytes.
 NS_IMETHOD_ (PRInt32) Fill(nsresult *aErrorCode
 Fill the buffer with data from aStream.

Public Attributes

nsIInputStreamaStream
nsIInputStream PRUint32 aKeep = 0

Detailed Description

Interface to a buffer that holds bytes.

Definition at line 56 of file nsIByteBuffer.h.


Member Function Documentation

NS_IMETHOD nsIByteBuffer::Init ( PRUint32  aBufferSize) [pure virtual]

Implemented in ByteBufferImpl.

nsIByteBuffer::NS_IMETHOD_ ( PRUint32  ) const [pure virtual]
Returns:
length of buffer, i.e. how many bytes are currently in it.

Implemented in ByteBufferImpl, and ByteBufferImpl.

nsIByteBuffer::NS_IMETHOD_ ( PRUint32  ) const [pure virtual]
Returns:
number of bytes allocated in the buffer

Implemented in ByteBufferImpl, and ByteBufferImpl.

nsIByteBuffer::NS_IMETHOD_ ( char *  ) const [pure virtual]
Returns:
the buffer

Implemented in ByteBufferImpl.

nsIByteBuffer::NS_IMETHOD_ ( PRBool  ) [pure virtual]

Grow buffer to aNewSize bytes.

Implemented in ByteBufferImpl.

Fill the buffer with data from aStream.

Don't grow the buffer, only read until length of buffer equals buffer size.

Reimplemented in ByteBufferImpl.


Member Data Documentation

Reimplemented in ByteBufferImpl.

Definition at line 77 of file nsIByteBuffer.h.

Reimplemented in ByteBufferImpl.

Definition at line 76 of file nsIByteBuffer.h.


The documentation for this class was generated from the following file: