Back to index

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

List of all members.

Public Member Functions

 ConsoleOutputStreamImpl (void)
virtual ~ConsoleOutputStreamImpl (void)
NS_DECL_ISUPPORTS NS_IMETHOD Close (void)
NS_IMETHOD Write (const char *aBuf, PRUint32 aCount, PRUint32 *aWriteCount)
NS_IMETHOD WriteFrom (nsIInputStream *inStr, PRUint32 count, PRUint32 *_retval)
NS_IMETHOD WriteSegments (nsReadSegmentFun reader, void *closure, PRUint32 count, PRUint32 *_retval)
NS_IMETHOD IsNonBlocking (PRBool *aNonBlocking)
NS_IMETHOD Flush (void)
 ConsoleOutputStreamImpl (void)
virtual ~ConsoleOutputStreamImpl (void)
NS_DECL_ISUPPORTS NS_IMETHOD Close (void)
NS_IMETHOD Write (const char *aBuf, PRUint32 aCount, PRUint32 *aWriteCount)
NS_IMETHOD WriteFrom (nsIInputStream *inStr, PRUint32 count, PRUint32 *_retval)
NS_IMETHOD WriteSegments (nsReadSegmentFun reader, void *closure, PRUint32 count, PRUint32 *_retval)
NS_IMETHOD IsNonBlocking (PRBool *aNonBlocking)
NS_IMETHOD Flush (void)
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 ()

Detailed Description

Definition at line 92 of file rdfcat.cpp.


Constructor & Destructor Documentation

Definition at line 95 of file rdfcat.cpp.

{}

Definition at line 96 of file rdfcat.cpp.

{}

Definition at line 93 of file triplescat.cpp.

{}

Definition at line 94 of file triplescat.cpp.

{}

Member Function Documentation

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)

Definition at line 100 of file triplescat.cpp.

                           {
        return NS_OK;
    }

Definition at line 102 of file rdfcat.cpp.

                           {
        return NS_OK;
    }
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)

Definition at line 129 of file triplescat.cpp.

                           {
        PR_Sync(PR_GetSpecialFD(PR_StandardOutput));
        return NS_OK;
    }

Definition at line 131 of file rdfcat.cpp.

                           {
        PR_Sync(PR_GetSpecialFD(PR_StandardOutput));
        return NS_OK;
    }

Definition at line 124 of file triplescat.cpp.

                                        {
        NS_NOTREACHED("IsNonBlocking");
        return NS_ERROR_NOT_IMPLEMENTED;
    }

Definition at line 126 of file rdfcat.cpp.

                                        {
        NS_NOTREACHED("IsNonBlocking");
        return NS_ERROR_NOT_IMPLEMENTED;
    }
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.

NS_IMETHOD ConsoleOutputStreamImpl::Write ( const char *  aBuf,
PRUint32  aCount,
PRUint32 aWriteCount 
) [inline]

Definition at line 105 of file triplescat.cpp.

                                                                               {
        PR_Write(PR_GetSpecialFD(PR_StandardOutput), aBuf, aCount);
        *aWriteCount = aCount;
        return NS_OK;
    }
NS_IMETHOD ConsoleOutputStreamImpl::Write ( const char *  aBuf,
PRUint32  aCount,
PRUint32 aWriteCount 
) [inline]

Definition at line 107 of file rdfcat.cpp.

                                                                               {
        PR_Write(PR_GetSpecialFD(PR_StandardOutput), aBuf, aCount);
        *aWriteCount = aCount;
        return NS_OK;
    }
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
NS_IMETHOD ConsoleOutputStreamImpl::WriteFrom ( nsIInputStream inStr,
PRUint32  count,
PRUint32 _retval 
) [inline]

Definition at line 112 of file triplescat.cpp.

                                                                        {
        NS_NOTREACHED("WriteFrom");
        return NS_ERROR_NOT_IMPLEMENTED;
    }
NS_IMETHOD ConsoleOutputStreamImpl::WriteFrom ( nsIInputStream inStr,
PRUint32  count,
PRUint32 _retval 
) [inline]

Definition at line 114 of file rdfcat.cpp.

                                                                        {
        NS_NOTREACHED("WriteFrom");
        return NS_ERROR_NOT_IMPLEMENTED;
    }
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.

NS_IMETHOD ConsoleOutputStreamImpl::WriteSegments ( nsReadSegmentFun  reader,
void closure,
PRUint32  count,
PRUint32 _retval 
) [inline]

Definition at line 118 of file triplescat.cpp.

                                                                                              {
        NS_NOTREACHED("WriteSegments");
        return NS_ERROR_NOT_IMPLEMENTED;
    }
NS_IMETHOD ConsoleOutputStreamImpl::WriteSegments ( nsReadSegmentFun  reader,
void closure,
PRUint32  count,
PRUint32 _retval 
) [inline]

Definition at line 120 of file rdfcat.cpp.

                                                                                              {
        NS_NOTREACHED("WriteSegments");
        return NS_ERROR_NOT_IMPLEMENTED;
    }
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).


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