Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsSanePluginStreamListener Class Reference

#include <nsSanePlugin.h>

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

List of all members.

Public Member Functions

NS_IMETHOD OnStartBinding (nsIPluginStreamInfo *pluginInfo)
NS_IMETHOD OnDataAvailable (nsIPluginStreamInfo *pluginInfo, nsIInputStream *input, PRUint32 length)
 Notify the client that data is available in the input stream.
NS_IMETHOD OnFileAvailable (nsIPluginStreamInfo *pluginInfo, const char *fileName)
NS_IMETHOD OnStopBinding (nsIPluginStreamInfo *pluginInfo, nsresult status)
 Notify the observer that the URL has finished loading.
NS_IMETHOD OnNotify (const char *url, nsresult status)
NS_IMETHOD GetStreamType (nsPluginStreamType *result)
 nsSanePluginStreamListener (nsSanePluginInstance *inst)
virtual ~nsSanePluginStreamListener (void)
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.

Public Attributes

 NS_DECL_ISUPPORTS
nsSanePluginInstancemPlugInst
readonly attribute
nsPluginStreamType 
streamType
 Gets the type of the stream.

Detailed Description

Definition at line 202 of file nsSanePlugin.h.


Constructor & Destructor Documentation

Definition at line 2006 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::nsSanePluginStreamListener()\n");
#endif

    PR_AtomicIncrement(&gPluginObjectCount);

    mPlugInst = inst;
}

Here is the call graph for this function:

Definition at line 2017 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::~nsSanePluginStreamListener()\n");
#endif

    PR_AtomicDecrement(&gPluginObjectCount);
}

Here is the call graph for this function:


Member Function Documentation

Definition at line 2089 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::GetStreamType()\n");
#endif

    *result = nsPluginStreamType_Normal;
    return NS_OK;
}
void nsIPluginStreamListener::onDataAvailable ( in nsIPluginStreamInfo  aPluginInfo,
in nsIInputStream  aInputStream,
in unsigned long  aLength 
) [inherited]

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.

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:
aIStreamThe input stream containing the data. This stream can be either a blocking or non-blocking stream.
lengthThe amount of data that was just pushed into the stream.
Returns:
The return value is currently ignored.

Definition at line 2042 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::OnDataAvailable()\n");
#endif

    // This plugin doesn't support 
    // streaming input data.
    return NS_OK;
}
void nsIPluginStreamListener::onFileAvailable ( in nsIPluginStreamInfo  aPluginInfo,
in string  aFileName 
) [inherited]

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.

Definition at line 2057 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::OnFileAvailable()\n");
#endif

    return NS_OK;
}

Definition at line 2079 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::OnNotify()\n");
#endif

    return NS_OK;
}

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..

Definition at line 2032 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::OnStartBinding()\n");
#endif

    return NS_OK;
}
void nsIPluginStreamListener::onStopBinding ( in nsIPluginStreamInfo  aPluginInfo,
in nsresult  aStatus 
) [inherited]

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.

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:
statusStatus code for the URL load.
msgA text string describing the error.
Returns:
The return value is currently ignored.

Definition at line 2068 of file nsSanePlugin.cpp.

{
#ifdef DEBUG
    printf("nsSanePluginStreamListener::OnStopBinding()\n");
#endif

    return NS_OK;
}

Member Data Documentation

Definition at line 258 of file nsSanePlugin.h.

Definition at line 206 of file nsSanePlugin.h.

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 class was generated from the following files: