2001-09-29 00:14:13 +04:00
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
2003-09-12 00:32:33 +04:00
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
1999-06-12 06:53:21 +04:00
|
|
|
*
|
2003-09-12 00:32:33 +04:00
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
1999-06-12 06:53:21 +04:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
1999-06-12 06:53:21 +04:00
|
|
|
*
|
2003-09-12 00:32:33 +04:00
|
|
|
* The Original Code is Mozilla.
|
1999-11-06 06:40:37 +03:00
|
|
|
*
|
2003-09-12 00:32:33 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
2001-09-29 00:14:13 +04:00
|
|
|
* Netscape Communications Corporation.
|
2003-09-12 00:32:33 +04:00
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2003
|
2001-09-29 00:14:13 +04:00
|
|
|
* the Initial Developer. All Rights Reserved.
|
1999-11-06 06:40:37 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Contributor(s):
|
2003-09-12 00:32:33 +04:00
|
|
|
* Gordon Sheridan <gordon@netscape.com>
|
|
|
|
* IBM Corp.
|
2001-09-29 00:14:13 +04:00
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
2003-09-12 00:32:33 +04:00
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
2001-09-29 00:14:13 +04:00
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
2003-09-12 00:32:33 +04:00
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
2001-09-29 00:14:13 +04:00
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
2003-09-12 00:32:33 +04:00
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
2001-09-29 00:14:13 +04:00
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
1999-06-12 06:53:21 +04:00
|
|
|
|
2003-09-12 00:32:33 +04:00
|
|
|
#include "nsIDNSRecord.idl"
|
|
|
|
#include "nsIDNSRequest.idl"
|
|
|
|
#include "nsIDNSListener.idl"
|
1999-06-12 06:53:21 +04:00
|
|
|
|
2003-09-12 00:32:33 +04:00
|
|
|
interface nsIEventQueue;
|
1999-06-12 06:53:21 +04:00
|
|
|
|
2003-09-12 00:32:33 +04:00
|
|
|
/**
|
|
|
|
* nsIDNSService
|
|
|
|
*/
|
|
|
|
[scriptable, uuid(98519315-f139-405e-9182-3339907c29fd)]
|
1999-06-12 06:53:21 +04:00
|
|
|
interface nsIDNSService : nsISupports
|
|
|
|
{
|
2003-09-12 00:32:33 +04:00
|
|
|
/**
|
|
|
|
* called to initialize the DNS service.
|
|
|
|
*/
|
|
|
|
void init();
|
2000-01-05 06:44:00 +03:00
|
|
|
|
2000-08-01 01:24:55 +04:00
|
|
|
/**
|
2003-09-12 00:32:33 +04:00
|
|
|
* called to shutdown the DNS service. any pending asynchronous
|
|
|
|
* requests will be canceled, and the local cache of DNS records
|
|
|
|
* will be cleared. NOTE: the operating system may still have
|
|
|
|
* its own cache of DNS records, which would be unaffected by
|
|
|
|
* this method.
|
|
|
|
*/
|
|
|
|
void shutdown();
|
2000-08-01 01:24:55 +04:00
|
|
|
|
2001-03-23 05:19:37 +03:00
|
|
|
/**
|
2003-09-12 00:32:33 +04:00
|
|
|
* kicks off an asynchronous host lookup.
|
|
|
|
*
|
|
|
|
* @param aHostName
|
|
|
|
* the hostname or IP-address-literal to resolve.
|
|
|
|
* @param aBypassCache
|
|
|
|
* if true, the internal DNS lookup cache will be bypassed.
|
|
|
|
* @param aListener
|
|
|
|
* the listener to be notified when the result is available.
|
|
|
|
* @param aListenerEventQ
|
|
|
|
* optional parameter (may be null). if non-null, this parameter
|
|
|
|
* specifies the nsIEventQueue of the thread on which the listener's
|
|
|
|
* onLookupComplete should be called. however, if this parameter is
|
|
|
|
* null, then onLookupComplete will be called on an unspecified
|
|
|
|
* thread (possibly recursively).
|
|
|
|
*
|
|
|
|
* @return DNS request instance that can be used to cancel the host lookup.
|
|
|
|
*/
|
|
|
|
nsIDNSRequest asyncResolve(in AUTF8String aHostName,
|
|
|
|
in boolean aBypassCache,
|
|
|
|
in nsIDNSListener aListener,
|
|
|
|
in nsIEventQueue aListenerEventQ);
|
2001-03-23 05:19:37 +03:00
|
|
|
|
2000-08-01 01:24:55 +04:00
|
|
|
/**
|
2003-09-12 00:32:33 +04:00
|
|
|
* called to synchronously resolve a hostname.
|
|
|
|
*
|
|
|
|
* @param aHostName
|
|
|
|
* the hostname or IP-address-literal to resolve.
|
|
|
|
* @param aBypassCache
|
|
|
|
* if true, the internal DNS lookup cache will be bypassed.
|
|
|
|
*
|
|
|
|
* @return DNS record corresponding to the given hostname.
|
|
|
|
* @throws NS_ERROR_UNKNOWN_HOST if host could not be resolved.
|
|
|
|
*/
|
|
|
|
nsIDNSRecord resolve(in AUTF8String aHostName,
|
|
|
|
in boolean aBypassCache);
|
2000-08-01 01:24:55 +04:00
|
|
|
|
2003-09-12 00:32:33 +04:00
|
|
|
/**
|
|
|
|
* @return the hostname of the operating system.
|
|
|
|
*/
|
|
|
|
readonly attribute AUTF8String myHostName;
|
1999-06-12 06:53:21 +04:00
|
|
|
};
|