netwerk/dns/public/nsIDNSService.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2003
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Gordon Sheridan <gordon@netscape.com>
  23  *   IBM Corp.
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsICancelable;
  42 interface nsIEventTarget;
  43 interface nsIDNSRecord;
  44 interface nsIDNSListener;
  45
  46 /**
  47  * nsIDNSService
  48  */
  49 [scriptable, uuid(ee4d9f1d-4f99-4384-b547-29da735f8b6e)]
  50 interface nsIDNSService : nsISupports
  51 {
  52     /**
  53      * kicks off an asynchronous host lookup.
  54      *
  55      * @param aHostName
  56      *        the hostname or IP-address-literal to resolve.
  57      * @param aFlags
  58      *        a bitwise OR of the RESOLVE_ prefixed constants defined below.
  59      * @param aListener
  60      *        the listener to be notified when the result is available.
  61      * @param aListenerTarget
  62      *        optional parameter (may be null).  if non-null, this parameter
  63      *        specifies the nsIEventTarget of the thread on which the
  64      *        listener's onLookupComplete should be called.  however, if this
  65      *        parameter is null, then onLookupComplete will be called on an
  66      *        unspecified thread (possibly recursively).
  67      *
  68      * @return An object that can be used to cancel the host lookup.
  69      */
  70     nsICancelable asyncResolve(in AUTF8String       aHostName,
  71                                in unsigned long     aFlags,
  72                                in nsIDNSListener    aListener,
  73                                in nsIEventTarget    aListenerTarget);
  74
  75     /**
  76      * called to synchronously resolve a hostname.  warning this method may
  77      * block the calling thread for a long period of time.  it is extremely
  78      * unwise to call this function on the UI thread of an application.
  79      *
  80      * @param aHostName
  81      *        the hostname or IP-address-literal to resolve.
  82      * @param aFlags
  83      *        a bitwise OR of the RESOLVE_ prefixed constants defined below.
  84      *
  85      * @return DNS record corresponding to the given hostname.
  86      * @throws NS_ERROR_UNKNOWN_HOST if host could not be resolved.
  87      */
  88     nsIDNSRecord resolve(in AUTF8String   aHostName,
  89                          in unsigned long aFlags);
  90
  91     /**
  92      * @return the hostname of the operating system.
  93      */
  94     readonly attribute AUTF8String myHostName;
  95
  96     /*************************************************************************
  97      * Listed below are the various flags that may be OR'd together to form
  98      * the aFlags parameter passed to asyncResolve() and resolve().
  99      */
 100
 101     /**
 102      * if set, this flag suppresses the internal DNS lookup cache.
 103      */
 104     const unsigned long RESOLVE_BYPASS_CACHE = (1 << 0);
 105
 106     /**
 107      * if set, the canonical name of the specified host will be queried.
 108      */
 109     const unsigned long RESOLVE_CANONICAL_NAME = (1 << 1);
 110
 111     /**
 112      * if set, the query is given lower priority. Medium takes precedence
 113      * if both are used.
 114      */
 115     const unsigned long RESOLVE_PRIORITY_MEDIUM = (1 << 2);
 116     const unsigned long RESOLVE_PRIORITY_LOW    = (1 << 3);
 117 };