nsIAsyncStreamCopier

Method overview

Methods

asyncCopy()

Starts the copy operation. The specified observer is notified when the copy completes.

void asyncCopy(
  in nsIRequestObserver aObserver,
  in nsISupports aObserverContext
);

Parameters

aObserver

Receives notifications.

aObserverContext

The object to receive notifications with information about the progress of the copy operation.

init()

Initializes the stream copier.

void init(
  in nsIInputStream aSource,
  in nsIOutputStream aSink,
  in nsIEventTarget aTarget,
  in boolean aSourceBuffered,
  in boolean aSinkBuffered,
  in unsigned long aChunkSize,
  in boolean aCloseSource, 
  in boolean aCloseSink 
);

Parameters

aSource

Contains the data to be copied.

aSink

Specifies the destination for the data.

aTarget

Specifies the thread on which the copy will occur. A null value is permitted and causes the copy to occur on an unspecified background thread.

aSourceBuffered

true if aSource implements nsIInputStream.readSegments().

aSinkBuffered

true if aSink implements nsIInputStream.writeSegments() .

aChunkSize

Specifies how many bytes to read and write at a time. This controls the granularity of the copy operation. This value should match the segment size of any buffered streams involved in the operation.

aCloseSource

true if aSource should be closed after copying.

aCloseSink

true if aSink should be closed after copying.

See also

• nsIInputStream
• nsIOutputStream