Back to index

lightning-sunbird  0.9+nobinonly
nsIProtocolHandler.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsIURI;
00041 interface nsIChannel;
00042 
00048 [scriptable, uuid(15fd6940-8ea7-11d3-93ad-00104ba0fd40)]
00049 interface nsIProtocolHandler : nsISupports
00050 {
00054     readonly attribute ACString scheme;
00055 
00061     readonly attribute long defaultPort;
00062 
00066     readonly attribute unsigned long protocolFlags;
00067 
00093     nsIURI newURI(in AUTF8String aSpec,
00094                   in string aOriginCharset,
00095                   in nsIURI aBaseURI);
00096 
00100     nsIChannel newChannel(in nsIURI aURI);
00101 
00111     boolean allowPort(in long port, in string scheme);
00112 
00113 
00114     /**************************************************************************
00115      * Constants for the protocol flags (the first is the default mask, the
00116      * others are deviations):
00117      *
00118      * NOTE: Implementation must ignore any flags they do not understand.
00119      */
00120 
00125     const unsigned long URI_STD = 0;
00126 
00130     const unsigned long URI_NORELATIVE = (1<<0);
00131 
00135     const unsigned long URI_NOAUTH = (1<<1);
00136 
00148     const unsigned long ALLOWS_PROXY = (1<<2);
00149 
00156     const unsigned long ALLOWS_PROXY_HTTP = (1<<3);
00157 };
00158 
00159 %{C++
00163 #define NS_NETWORK_PROTOCOL_CONTRACTID_PREFIX "@mozilla.org/network/protocol;1?name="
00164 
00167 %}