FreeWRL / FreeX3D 4.3.0
nsIPluginStreamListener Interface Reference

nsIPluginStreamListener More...

import <nsIPluginStreamListener.idl;

Inheritance diagram for nsIPluginStreamListener:

Public Member Functions

void onStartBinding (in nsIPluginStreamInfo aPluginInfo)
 Notify the observer that the URL has started to load.
 
void onDataAvailable (in nsIPluginStreamInfo aPluginInfo, in nsIInputStream aInputStream, in unsigned long aLength)
 Notify the client that data is available in the input stream.
 
void onFileAvailable (in nsIPluginStreamInfo aPluginInfo, in string aFileName)
 Notify the client that data is available in the file.
 
void onStopBinding (in nsIPluginStreamInfo aPluginInfo, in nsresult aStatus)
 Notify the observer that the URL has finished loading.
 

Data Fields

readonly attribute nsPluginStreamType streamType
 Gets the type of the stream.
 

Detailed Description

nsIPluginStreamListener

@status DEPRECATED

Originally published XPCOM Plugin API is now deprecated Developers are welcome to use NPAPI, please refer to: http://mozilla.org/projects/plugins/ The nsIPluginStreamListener interface defines the minimum set of functionality that the browser will support if it allows plugins. Plugins can call QueryInterface to determine if a plugin manager implements more specific APIs or other browser interfaces for the plugin to use (e.g. nsINetworkManager).

Definition at line 64 of file nsIPluginStreamListener.idl.

Member Function Documentation

◆ onDataAvailable()

void nsIPluginStreamListener::onDataAvailable ( in nsIPluginStreamInfo aPluginInfo,
in nsIInputStream aInputStream,
in unsigned long aLength )

Notify the client that data is available in the input stream.

This method is called whenver data is written into the input stream by the networking library...

Parameters
aPluginInfo- plugin stream info
aInputStream- the input stream containing the data. This stream can be either a blocking or non-blocking stream.
aLength- the amount of data that was just pushed into the stream.
Returns
- the return value is currently ignored.

◆ onFileAvailable()

void nsIPluginStreamListener::onFileAvailable ( in nsIPluginStreamInfo aPluginInfo,
in string aFileName )

Notify the client that data is available in the file.

Parameters
aPluginInfo- plugin stream info
aFileName- the name of the file containing the data
Returns
- the return value is currently ignored.

◆ onStartBinding()

void nsIPluginStreamListener::onStartBinding ( in nsIPluginStreamInfo aPluginInfo)

Notify the observer that the URL has started to load.

This method is called only once, at the beginning of a URL load.

Parameters
aPluginInfo- plugin stream info
Returns
- the return value is currently ignored, in the future it may be used to cancel the URL load..

◆ onStopBinding()

void nsIPluginStreamListener::onStopBinding ( in nsIPluginStreamInfo aPluginInfo,
in nsresult aStatus )

Notify the observer that the URL has finished loading.

This method is called once when the networking library has finished processing the URL transaction initiatied via the nsINetService::Open(...) call.

This method is called regardless of whether the URL loaded successfully.

Parameters
aPluginInfo- plugin stream info
aStatus- reason why the stream has been terminated
Returns
- the return value is currently ignored.

Field Documentation

◆ streamType

readonly attribute nsPluginStreamType nsIPluginStreamListener::streamType

Gets the type of the stream.

Parameters
aStreamType- the type of the stream

Definition at line 118 of file nsIPluginStreamListener.idl.


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