Back to index

enigmail  1.4.3
Public Member Functions | Public Attributes
nsIIPCBuffer Interface Reference

import "nsIIPCBuffer.idl";

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

List of all members.

Public Member Functions

void open (in long maxBytes, in boolean overflowFile)
 Opens byte buffer.
void openURI (in nsIURI aURI, in long maxBytes, in boolean synchronous, in nsIRequestObserver observer, in nsISupports ctxt, in boolean overflowFile)
 Loads an URI into the console buffer (use instead of the open method)
nsIInputStream openInputStream ()
 Opens an input stream to access buffer data; should be called only after the OnStopRequest call to streamListener.
string getData ()
 Returns data from buffer (as a NUL-terminated string)
void observe (in nsIRequestObserver observer, in nsISupports ctxt)
 Observes any asynchronous request associated with console.
void join ()
 Close input pipe and blocks for console logging thread to terminate, ensuring that all data already written to the console pipe is available for reading from console buffer.
void shutdown ()
 Shuts down listener (without blocking).
void getByteData (out unsigned long count,[retval, size_is(count)] out string data)
 Accesses buffer data as a string of arbitrary bytes, including NUL characters.
void write (in string str)
 Writes a string into the buffer.
void writeBuf (in string buf, in unsigned long count)
 Writes data into the buffer.

Public Attributes

readonly attribute boolean stopped
 True if onStopRequest method of StreamListener has been invoked.
readonly attribute unsigned long totalBytes
 Count of total bytes in buffer (or overflow file)
readonly attribute boolean joinable
 true if console pipe thread may be terminated
readonly attribute boolean overflowed
 True if data has been lost (i.e., getByteData does not return all data)

Detailed Description

Definition at line 59 of file nsIIPCBuffer.idl.


Member Function Documentation

void nsIPipeListener::getByteData ( out unsigned long  count,
[retval, size_is(count)] out string  data 
) [inherited]

Accesses buffer data as a string of arbitrary bytes, including NUL characters.

Returns data from buffer (as a NUL-terminated string)

void nsIPipeListener::join ( ) [inherited]

Close input pipe and blocks for console logging thread to terminate, ensuring that all data already written to the console pipe is available for reading from console buffer.

void nsIPipeListener::observe ( in nsIRequestObserver  observer,
in nsISupports  ctxt 
) [inherited]

Observes any asynchronous request associated with console.

(E.g., when console is used to capture stdout from nsIPipeTransport.execAsync)

Parameters:
observerThe nsIRequestObserver object
ctxtA user-defined context value that is passed to the observer.
void nsIIPCBuffer::open ( in long  maxBytes,
in boolean  overflowFile 
)

Opens byte buffer.

Parameters:
maxBytesmaximum number of bytes to be read (maxBytes <= 0 --> unlimited buffer size)
overflowFiledetermines if a temporary file should be created if the data to hold in the buffer grows larger than maxBytes. If false and the buffer reached maxBytes then reading will block until data is read from the buffer.
nsIInputStream nsIIPCBuffer::openInputStream ( )

Opens an input stream to access buffer data; should be called only after the OnStopRequest call to streamListener.

Note: On closing the stream, the buffer will be cleared

void nsIIPCBuffer::openURI ( in nsIURI  aURI,
in long  maxBytes,
in boolean  synchronous,
in nsIRequestObserver  observer,
in nsISupports  ctxt,
in boolean  overflowFile 
)

Loads an URI into the console buffer (use instead of the open method)

Parameters:
aURIURI to be loaded
maxBytesmaximum number of bytes to be read (maxBytes <= 0 --> unlimited buffer size)
synchronousdetermines whether to load synchronously (NOTE: This DOESN'T WORK if the input stream operates on the same thread -- reading and writing are both blocking operations)
observera request observer (same as if defined via observe())
ctxtopaque parameter passed to listener methods
overflowFiledetermines if a temporary file should be created (see open() for details)
void nsIPipeListener::shutdown ( ) [inherited]

Shuts down listener (without blocking).

Any data already written to the input pipe is discarded.

void nsIPipeListener::write ( in string  str) [inherited]

Writes a string into the buffer.

void nsIPipeListener::writeBuf ( in string  buf,
in unsigned long  count 
) [inherited]

Writes data into the buffer.

Data is a string of arbitrary bytes including NUL characters.


Member Data Documentation

readonly attribute boolean nsIPipeListener::joinable [inherited]

true if console pipe thread may be terminated

Definition at line 65 of file nsIPipeListener.idl.

readonly attribute boolean nsIPipeListener::overflowed [inherited]

True if data has been lost (i.e., getByteData does not return all data)

Definition at line 90 of file nsIPipeListener.idl.

readonly attribute boolean nsIIPCBuffer::stopped

True if onStopRequest method of StreamListener has been invoked.

Definition at line 113 of file nsIIPCBuffer.idl.

readonly attribute unsigned long nsIIPCBuffer::totalBytes

Count of total bytes in buffer (or overflow file)

Definition at line 118 of file nsIIPCBuffer.idl.


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