Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Private Attributes
nsPipeOutputStream Class Reference
Inheritance diagram for nsPipeOutputStream:
Inheritance graph
[legend]
Collaboration diagram for nsPipeOutputStream:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS_INHERITED
NS_DECL_NSIOUTPUTSTREAM
NS_DECL_NSIASYNCOUTPUTSTREAM
NS_DECL_NSISEEKABLESTREAM 
nsPipeOutputStream (nsPipe *pipe)
void SetNonBlocking (PRBool aNonBlocking)
void SetWritable (PRBool writable)
nsresult Wait ()
PRBool OnOutputWritable (nsPipeEvents &)
PRBool OnOutputException (nsresult, nsPipeEvents &)
void closeWithStatus (in nsresult reason)
 This method closes the stream and sets its internal status.
void asyncWait (in nsIOutputStreamCallback aCallback, in unsigned long aFlags, in unsigned long aRequestedCount, in nsIEventTarget aEventTarget)
 Asynchronously wait for the stream to be writable or closed.
void close ()
 Close the stream.
void flush ()
 Flush the stream.
unsigned long write (in string aBuf, in unsigned long aCount)
 Write data into the stream.
unsigned long writeFrom (in nsIInputStream aFromStream, in unsigned long aCount)
 Writes data into the stream from an input stream.
unsigned long writeSegments (in nsReadSegmentFun aReader, in voidPtr aClosure, in unsigned long aCount)
 Low-level write method that has access to the stream's underlying buffer.
boolean isNonBlocking ()
void seek (in long whence, in long long offset)
 seek
long long tell ()
 tell
void setEOF ()
 setEOF

Public Attributes

const unsigned long WAIT_CLOSURE_ONLY = (1<<0)
 If passed to asyncWait, this flag overrides the default behavior, causing the OnOutputStreamReady notification to be suppressed until the stream becomes closed (either as a result of closeWithStatus/close being called on the stream or possibly due to some error in the underlying stream).
const PRInt32 NS_SEEK_SET = 0
const PRInt32 NS_SEEK_CUR = 1
const PRInt32 NS_SEEK_END = 2

Private Attributes

nsPipemPipe
nsrefcnt mWriterRefCnt
nsInt64 mLogicalOffset
PRPackedBool mBlocking
PRPackedBool mBlocked
PRPackedBool mWritable
nsCOMPtr< nsIOutputStreamCallbackmCallback
PRUint32 mCallbackFlags

Detailed Description

Definition at line 163 of file nsPipe3.cpp.


Constructor & Destructor Documentation

NS_DECL_ISUPPORTS_INHERITED NS_DECL_NSIOUTPUTSTREAM NS_DECL_NSIASYNCOUTPUTSTREAM NS_DECL_NSISEEKABLESTREAM nsPipeOutputStream::nsPipeOutputStream ( nsPipe pipe) [inline]

Definition at line 178 of file nsPipe3.cpp.


Member Function Documentation

void nsIAsyncOutputStream::asyncWait ( in nsIOutputStreamCallback  aCallback,
in unsigned long  aFlags,
in unsigned long  aRequestedCount,
in nsIEventTarget  aEventTarget 
) [inherited]

Asynchronously wait for the stream to be writable or closed.

The notification is one-shot, meaning that each asyncWait call will result in exactly one notification callback. After the OnOutputStreamReady event is dispatched, the stream releases its reference to the nsIOutputStreamCallback object. It is safe to call asyncWait again from the notification handler.

This method may be called at any time (even if write has not been called). In other words, this method may be called when the stream already has room for more data. It may also be called when the stream is closed. If the stream is already writable or closed when AsyncWait is called, then the OnOutputStreamReady event will be dispatched immediately. Otherwise, the event will be dispatched when the stream becomes writable or closed.

Parameters:
aCallbackThis object is notified when the stream becomes ready.
aFlagsThis parameter specifies optional flags passed in to configure the behavior of this method. Pass zero to specify no flags.
aRequestedCountWait until at least this many bytes can be written. This is only a suggestion to the underlying stream; it may be ignored. The caller may pass zero to indicate no preference.
aEventTargetSpecify NULL to receive notification on ANY thread (possibly even recursively on the calling thread -- i.e., synchronously), or specify that the notification be delivered to a specific event target.
void nsIOutputStream::close ( ) [inherited]

Close the stream.

Forces the output stream to flush any buffered data.

Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif unable to flush without blocking the calling thread (non-blocking mode only)

This method closes the stream and sets its internal status.

If the stream is already closed, then this method is ignored. Once the stream is closed, the stream's status cannot be changed. Any successful status code passed to this method is treated as NS_BASE_STREAM_CLOSED, which is equivalent to nsIInputStream::close.

NOTE: this method exists in part to support pipes, which have both an input end and an output end. If the output end of a pipe is closed, then reads from the input end of the pipe will fail. The error code returned when an attempt is made to read from a "closed" pipe corresponds to the status code passed in when the output end of the pipe is closed, which greatly simplifies working with pipes in some cases.

Parameters:
aStatusThe error that will be reported if this stream is accessed after it has been closed.
void nsIOutputStream::flush ( ) [inherited]

Flush the stream.

Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif unable to flush without blocking the calling thread (non-blocking mode only)
Returns:
true if stream is non-blocking

NOTE: writing to a blocking output stream will block the calling thread until all given data can be consumed by the stream.

Definition at line 997 of file nsPipe3.cpp.

{
    LOG(("nsPipeOutputStream::OnOutputException [this=%x reason=%x]\n",
        this, reason));

    nsresult result = PR_FALSE;

    NS_ASSERTION(NS_FAILED(reason), "huh? successful exception");
    mWritable = PR_FALSE;

    if (mCallback) {
        events.NotifyOutputReady(this, mCallback);
        mCallback = 0;
        mCallbackFlags = 0;
    }
    else if (mBlocked)
        result = PR_TRUE;

    return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 979 of file nsPipe3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nsISeekableStream::seek ( in long  whence,
in long long  offset 
) [inherited]

seek

This method moves the stream offset of the steam implementing this interface.

Parameters:
whencespecifies how to interpret the 'offset' parameter in setting the stream offset associated with the implementing stream.
offsetspecifies a value, in bytes, that is used in conjunction with the 'whence' parameter to set the stream offset of the implementing stream. A negative value causes seeking in the reverse direction.

setEOF

This method truncates the stream at the current offset.

void nsPipeOutputStream::SetNonBlocking ( PRBool  aNonBlocking) [inline]

Definition at line 188 of file nsPipe3.cpp.

{ mBlocking = !aNonBlocking; }

Definition at line 189 of file nsPipe3.cpp.

{ mWritable = writable; }

Here is the caller graph for this function:

tell

This method reports the current offset, in bytes, from the start of the stream.

Definition at line 960 of file nsPipe3.cpp.

{
    NS_ASSERTION(mBlocking, "wait on non-blocking pipe output stream");

    nsAutoMonitor mon(mPipe->mMonitor);

    if (NS_SUCCEEDED(mPipe->mStatus) && !mWritable) {
        LOG(("OOO pipe output: waiting for space\n"));
        mBlocked = PR_TRUE;
        mon.Wait();
        mBlocked = PR_FALSE;
        LOG(("OOO pipe output: woke up [pipe-status=%x writable=%u]\n",
            mPipe->mStatus, mWritable == PR_TRUE));
    }

    return mPipe->mStatus == NS_BASE_STREAM_CLOSED ? NS_OK : mPipe->mStatus;
}
unsigned long nsIOutputStream::write ( in string  aBuf,
in unsigned long  aCount 
) [inherited]

Write data into the stream.

Parameters:
aBufthe buffer containing the data to be written
aCountthe maximum number of bytes to be written
Returns:
number of bytes written (may be less than aCount)
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif writing to the output stream would block the calling thread (non-blocking mode only)
<other-error>on failure
unsigned long nsIOutputStream::writeFrom ( in nsIInputStream  aFromStream,
in unsigned long  aCount 
) [inherited]

Writes data into the stream from an input stream.

Parameters:
aFromStreamthe stream containing the data to be written
aCountthe maximum number of bytes to be written
Returns:
number of bytes written (may be less than aCount)
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif writing to the output stream would block the calling thread (non-blocking mode only)
<other-error>on failure

NOTE: This method is defined by this interface in order to allow the output stream to efficiently copy the data from the input stream into its internal buffer (if any). If this method was provided as an external facility, a separate char* buffer would need to be used in order to call the output stream's other Write method.

unsigned long nsIOutputStream::writeSegments ( in nsReadSegmentFun  aReader,
in voidPtr  aClosure,
in unsigned long  aCount 
) [inherited]

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

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

Parameters:
aReaderthe "provider" of the data to be written
aClosureopaque parameter passed to reader
aCountthe maximum number of bytes to be written
Returns:
number of bytes written (may be less than aCount)
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif writing to the output 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 output stream).


Member Data Documentation

Definition at line 208 of file nsPipe3.cpp.

Definition at line 205 of file nsPipe3.cpp.

Definition at line 210 of file nsPipe3.cpp.

Definition at line 211 of file nsPipe3.cpp.

Definition at line 204 of file nsPipe3.cpp.

Definition at line 200 of file nsPipe3.cpp.

Definition at line 209 of file nsPipe3.cpp.

Definition at line 203 of file nsPipe3.cpp.

Definition at line 62 of file nsISeekableStream.idl.

Definition at line 68 of file nsISeekableStream.idl.

Definition at line 56 of file nsISeekableStream.idl.

const unsigned long nsIAsyncOutputStream::WAIT_CLOSURE_ONLY = (1<<0) [inherited]

If passed to asyncWait, this flag overrides the default behavior, causing the OnOutputStreamReady notification to be suppressed until the stream becomes closed (either as a result of closeWithStatus/close being called on the stream or possibly due to some error in the underlying stream).

Definition at line 120 of file nsIAsyncOutputStream.idl.


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