netwerk/dns/public/nsIDNSRecord.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 IBM Corporation.
  17  * Portions created by IBM Corporation are Copyright (C) 2003
  18  * IBM Corporation. All Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *   IBM Corp.
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsISupports.idl"
  38
  39 native PRNetAddr(union PRNetAddr);
  40
  41 /**
  42  * nsIDNSRecord
  43  *
  44  * this interface represents the result of a DNS lookup.  since a DNS
  45  * query may return more than one resolved IP address, the record acts
  46  * like an enumerator, allowing the caller to easily step through the
  47  * list of IP addresses.
  48  */
  49 [scriptable, uuid(31c9c52e-1100-457d-abac-d2729e43f506)]
  50 interface nsIDNSRecord : nsISupports
  51 {
  52     /**
  53      * @return the canonical hostname for this record.  this value is empty if
  54      * the record was not fetched with the RESOLVE_CANONICAL_NAME flag.
  55      *
  56      * e.g., www.mozilla.org --> rheet.mozilla.org
  57      */
  58     readonly attribute ACString canonicalName;
  59
  60     /**
  61      * this function copies the value of the next IP address into the
  62      * given PRNetAddr struct and increments the internal address iterator.
  63      *
  64      * @param aPort
  65      *        A port number to initialize the PRNetAddr with.
  66      *
  67      * @throws NS_ERROR_NOT_AVAILABLE if there is not another IP address in
  68      * the record.
  69      */
  70     [noscript] PRNetAddr getNextAddr(in PRUint16 aPort);
  71
  72     /**
  73      * this function returns the value of the next IP address as a
  74      * string and increments the internal address iterator.
  75      *
  76      * @throws NS_ERROR_NOT_AVAILABLE if there is not another IP address in
  77      * the record.
  78      */
  79     ACString getNextAddrAsString();
  80
  81     /**
  82      * this function returns true if there is another address in the record.
  83      */
  84     boolean hasMore();
  85
  86     /**
  87      * this function resets the internal address iterator to the first
  88      * address in the record.
  89      */
  90     void rewind();
  91 };