gecko-dev/netwerk/dns/public/nsIDNSService.idl

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is 
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1999
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or 
 * 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
 * use your version of this file under the terms of the NPL, indicate your
 * 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
 * the terms of any one of the NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

%{C++

#define NS_DNSSERVICE_CID                              \
{ /* 718e7c81-f8b8-11d2-b951-c80918051d3c */           \
    0x718e7c81,                                        \
    0xf8b8,                                            \
    0x11d2,                                            \
    { 0xb9, 0x51, 0xc8, 0x09, 0x18, 0x05, 0x1d, 0x3c } \
}

%}

interface nsIRequest;
interface nsIDNSListener;

[scriptable, uuid(598f2f80-206f-11d3-9348-00104ba0fd40)]
interface nsIDNSService : nsISupports
{
    nsIRequest lookup(in string hostname,
                      in nsIDNSListener listener,
                      in nsISupports ctxt);

    /**
    * Synchronously resolve the hostname to its IP address. 
    */
    string resolve(in string hostname);

    /**
    * returns our own IP address
    */
    readonly attribute string myIPAddress;

    /**
    * Check if the specified address is in the network of the pattern
    * using the specified mask. This function would probably go away 
    * once an implementation for it in JS exists for nsProxyAutoConfig.
    * See http://www.mozilla.org/docs/netlib/pac.html for more info.
    */
    boolean isInNet(in string ipaddr, in string pattern, in string mask);

    void init();
    void shutdown();
};

%{C++

#define NS_ERROR_UNKNOWN_HOST  NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_NETWORK, 30)

%}