Logo Search packages:      
Sourcecode: xulrunner version File versions

nsIChannel Interface Reference

import "nsIChannel.idl";

Inheritance diagram for nsIChannel:

nsIRequest nsISupports nsIconChannel nsIconChannel nsIconChannel nsIconChannel nsIconChannel nsIconChannel nsIHttpChannel nsIWyciwygChannel

List of all members.

Detailed Description

The nsIChannel interface allows clients to construct "GET" requests for specific protocols, and manage them in a uniform way. Once a channel is created (via nsIIOService::newChannel), parameters for that request may be set by using the channel attributes, or by QI'ing to a subclass of nsIChannel for protocol-specific parameters. Then, the URI can be fetched by calling nsIChannel::open or nsIChannel::asyncOpen.

After a request has been completed, the channel is still valid for accessing protocol-specific results. For example, QI'ing to nsIHttpChannel allows response headers to be retrieved for the corresponding http transaction.


Definition at line 60 of file nsIChannel.idl.

Public Member Functions

void asyncOpen (in nsIStreamListener aListener, in nsISupports aContext)
void cancel (in nsresult aStatus)
boolean isPending ()
nsIInputStream open ()
void resume ()
void suspend ()
 NS_IMETHOD_ (nsrefcnt) Release(void)=0
 NS_IMETHOD_ (nsrefcnt) AddRef(void)=0
NS_IMETHOD QueryInterface (REFNSIID aIID, void **aInstancePtr)=0

Public Attributes

attribute ACString contentCharset
attribute long contentLength
attribute ACString contentType
const unsigned long INHIBIT_CACHING = 1 << 7
const unsigned long INHIBIT_PERSISTENT_CACHING = 1 << 8
const unsigned long LOAD_ANONYMOUS = 1 << 14
const unsigned long LOAD_BACKGROUND = 1 << 0
const unsigned long LOAD_BYPASS_CACHE = 1 << 9
const unsigned long LOAD_CALL_CONTENT_SNIFFERS = 1 << 21
const unsigned long LOAD_DOCUMENT_URI = 1 << 16
const unsigned long LOAD_FROM_CACHE = 1 << 10
const unsigned long LOAD_INITIAL_DOCUMENT_URI = 1 << 19
const unsigned long LOAD_NORMAL = 0
const unsigned long LOAD_REPLACE = 1 << 18
const unsigned long LOAD_RETARGETED_DOCUMENT_URI = 1 << 17
const unsigned long LOAD_TARGETED = 1 << 20
attribute nsLoadFlags loadFlags
attribute nsILoadGroup loadGroup
readonly attribute AUTF8String name
attribute nsIInterfaceRequestor notificationCallbacks
attribute nsIURI originalURI
attribute nsISupports owner
readonly attribute nsISupports securityInfo
readonly attribute nsresult status
readonly attribute nsIURI URI
const unsigned long VALIDATE_ALWAYS = 1 << 11
const unsigned long VALIDATE_NEVER = 1 << 12
const unsigned long VALIDATE_ONCE_PER_SESSION = 1 << 13

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

Generated by  Doxygen 1.6.0   Back to index