Back to index

enigmail  1.4.3
Public Member Functions | Public Attributes
nsIPipeListener Interface Reference

import "nsIPipeListener.idl";

Inheritance diagram for nsIPipeListener:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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 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 49 of file nsIPipeListener.idl.


Member Function Documentation

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

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

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 
)

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.

Shuts down listener (without blocking).

Any data already written to the input pipe is discarded.

void nsIPipeListener::write ( in string  str)

Writes a string into the buffer.

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

Writes data into the buffer.

Data is a string of arbitrary bytes including NUL characters.


Member Data Documentation

readonly attribute boolean nsIPipeListener::joinable

true if console pipe thread may be terminated

Definition at line 65 of file nsIPipeListener.idl.

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

Definition at line 90 of file nsIPipeListener.idl.


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