Back to index

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

#include <nsJARInputStream.h>

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

List of all members.

Public Member Functions

 nsJARInputStream ()
virtual ~nsJARInputStream ()
 NS_DEFINE_STATIC_CID_ACCESSOR (NS_JARINPUTSTREAM_CID)
NS_DECL_ISUPPORTS
NS_DECL_NSIINPUTSTREAM
nsresult 
Init (nsJAR *jar, const char *aFilename)
void close ()
 Close the stream.
unsigned long available ()
unsigned long read (in charPtr aBuf, in unsigned long aCount)
 Read data from the stream.
unsigned long readSegments (in nsWriteSegmentFun aWriter, in voidPtr aClosure, in unsigned long aCount)
 Low-level read method that has access to the stream's underlying buffer.
boolean isNonBlocking ()

Protected Attributes

nsZipReadState mReadInfo
nsJARmJAR

Detailed Description

Definition at line 57 of file nsJARInputStream.h.


Constructor & Destructor Documentation

Definition at line 121 of file nsJARInputStream.cpp.

    : mJAR(nsnull)
{
}

Definition at line 126 of file nsJARInputStream.cpp.

{
  Close();
}

Member Function Documentation

unsigned long nsIInputStream::available ( ) [inherited]
Returns:
number of bytes currently available in the stream
void nsIInputStream::close ( ) [inherited]

Close the stream.

nsresult nsJARInputStream::Init ( nsJAR jar,
const char *  aFilename 
)

Definition at line 97 of file nsJARInputStream.cpp.

{
  if (!aFilename)
    return NS_ERROR_NULL_POINTER;
  mJAR = aJAR;
  NS_ADDREF(mJAR);

  PRInt32 result;
  PRFileDesc* fd = aJAR->OpenFile();
  NS_ASSERTION(fd, "Couldn't open JAR!");

  if (!fd)
      return NS_ERROR_UNEXPECTED;
  
  result = aJAR->mZip.ReadInit(aFilename, &mReadInfo, fd);
  if (result != ZIP_OK)
    return NS_ERROR_FAILURE;
  return NS_OK;
}

Here is the call graph for this function:

Returns:
true if stream is non-blocking
unsigned long nsIInputStream::read ( in charPtr  aBuf,
in unsigned long  aCount 
) [inherited]

Read data from the stream.

Parameters:
aBufthe buffer into which the data is to be read
aCountthe maximum number of bytes to be read
Returns:
number of bytes read (may be less than aCount).
0 if reached end of file
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif reading from the input stream would block the calling thread (non-blocking mode only)
<other-error>on failure
unsigned long nsIInputStream::readSegments ( in nsWriteSegmentFun  aWriter,
in voidPtr  aClosure,
in unsigned long  aCount 
) [inherited]

Low-level read method that has access to the stream's underlying buffer.

The writer function may be called multiple times for segmented buffers. ReadSegments is expected to keep calling the writer until either there is nothing left to read or the writer returns an error. ReadSegments should not call the writer with zero bytes to consume.

Parameters:
aWriterthe "consumer" of the data to be read
aClosureopaque parameter passed to writer
aCountthe maximum number of bytes to be read
Returns:
number of bytes read (may be less than aCount)
0 if reached end of file (or if aWriter refused to consume data)
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif reading from the input stream would block the calling thread (non-blocking mode only)
<other-error>on failure

NOTE: this function may be unimplemented if a stream has no underlying buffer (e.g., socket input stream).


Member Data Documentation

Definition at line 75 of file nsJARInputStream.h.

Definition at line 73 of file nsJARInputStream.h.


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