/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "nsISupports.idl" %{ C++ #include "mozilla/BasePrincipal.h" %} interface nsICancelable; interface nsIEventTarget; interface nsIDNSRecord; interface nsIDNSListener; %{C++ #include "nsTArrayForwardDeclare.h" namespace mozilla { namespace net { struct DNSCacheEntries; } } %} [ptr] native EntriesArray(nsTArray); [ref] native OriginAttributes(const mozilla::OriginAttributes); /** * nsIDNSService */ [scriptable, builtinclass, uuid(de5642c6-61fc-4fcf-9a47-03226b0d4e21)] interface nsIDNSService : nsISupports { /** * kicks off an asynchronous host lookup. * * @param aHostName * the hostname or IP-address-literal to resolve. * @param aFlags * a bitwise OR of the RESOLVE_ prefixed constants defined below. * @param aListener * the listener to be notified when the result is available. * @param aListenerTarget * optional parameter (may be null). if non-null, this parameter * specifies the nsIEventTarget 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). * @param aOriginAttributes * the originAttribute for this resolving, the DNS cache will be * separated according to this originAttributes. This attribute is * optional to avoid breaking add-ons. * * @return An object that can be used to cancel the host lookup. */ [implicit_jscontext, optional_argc] nsICancelable asyncResolve(in AUTF8String aHostName, in unsigned long aFlags, in nsIDNSListener aListener, in nsIEventTarget aListenerTarget, [optional] in jsval aOriginAttributes); [notxpcom] nsresult asyncResolveNative(in AUTF8String aHostName, in unsigned long aFlags, in nsIDNSListener aListener, in nsIEventTarget aListenerTarget, in OriginAttributes aOriginAttributes, out nsICancelable aResult); /** * kicks off an asynchronous host lookup by type, e.g. TXT. * * @param aHostName * the hostname or IP-address-literal to resolve. * @param aType * one of RESOLVE_TYPE_*. * @param aFlags * a bitwise OR of the RESOLVE_ prefixed constants defined below * except RESOLVE_CANONICAL_NAME, RESOLVE_DISABLE_IPV6 and * RESOLVE_DISABLE_IPV4. * @param aListener * the listener to be notified when the result is available. * @param aListenerTarget * optional parameter (may be null). if non-null, this parameter * specifies the nsIEventTarget 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). * @param aOriginAttributes * the originAttribute for this resolving, the DNS cache will be * separated according to this originAttributes. * * @return An object that can be used to cancel the host lookup. */ [implicit_jscontext, optional_argc] nsICancelable asyncResolveByType(in AUTF8String aHostName, in unsigned short aType, in unsigned long aFlags, in nsIDNSListener aListener, in nsIEventTarget aListenerTarget, in jsval aOriginAttributes); [notxpcom] nsresult asyncResolveByTypeNative(in AUTF8String aHostName, in unsigned short aType, in unsigned long aFlags, in nsIDNSListener aListener, in nsIEventTarget aListenerTarget, in OriginAttributes aOriginAttributes, out nsICancelable aResult); /** * Attempts to cancel a previously requested async DNS lookup * * @param aHostName * the hostname or IP-address-literal to resolve. * @param aFlags * a bitwise OR of the RESOLVE_ prefixed constants defined below. * @param aListener * the original listener which was to be notified about the host lookup * result - used to match request information to requestor. * @param aReason * nsresult reason for the cancellation * @param aOriginAttributes * the originAttribute for this resolving. This attribute is optional * to avoid breaking add-ons. */ [implicit_jscontext, optional_argc] void cancelAsyncResolve(in AUTF8String aHostName, in unsigned long aFlags, in nsIDNSListener aListener, in nsresult aReason, [optional] in jsval aOriginAttributes); [notxpcom] nsresult cancelAsyncResolveNative(in AUTF8String aHostName, in unsigned long aFlags, in nsIDNSListener aListener, in nsresult aReason, in OriginAttributes aOriginAttributes); /** * Attempts to cancel a previously requested async DNS lookup * * @param aHostName * the hostname or IP-address-literal to resolve. * @param aType * one of RESOLVE_TYPE_*. * @param aFlags * a bitwise OR of the RESOLVE_ prefixed constants defined below * except RESOLVE_CANONICAL_NAME, RESOLVE_DISABLE_IPV6 and * RESOLVE_DISABLE_IPV4. * @param aListener * the original listener which was to be notified about the host lookup * result - used to match request information to requestor. * @param aReason * nsresult reason for the cancellation * @param aOriginAttributes * the originAttribute for this resolving. This attribute is optional * to avoid breaking add-ons. * */ [implicit_jscontext, optional_argc] void cancelAsyncResolveByType(in AUTF8String aHostName, in unsigned short aType, in unsigned long aFlags, in nsIDNSListener aListener, in nsresult aReason, in jsval aOriginAttributes); [notxpcom] nsresult cancelAsyncResolveByTypeNative(in AUTF8String aHostName, in unsigned short aType, in unsigned long aFlags, in nsIDNSListener aListener, in nsresult aReason, in OriginAttributes aOriginAttributes); /** * called to synchronously resolve a hostname. * * Since this method may block the calling thread for a long period of * time, it may not be accessed from the main thread. * * @param aHostName * the hostname or IP-address-literal to resolve. * @param aFlags * a bitwise OR of the RESOLVE_ prefixed constants defined below. * @param aOriginAttributes * the originAttribute for this resolving, the DNS cache will be * separated according to this originAttributes. This attribute is * optional to avoid breaking add-ons. * * @return DNS record corresponding to the given hostname. * @throws NS_ERROR_UNKNOWN_HOST if host could not be resolved. * @throws NS_ERROR_NOT_AVAILABLE if accessed from the main thread. */ [implicit_jscontext, optional_argc] nsIDNSRecord resolve(in AUTF8String aHostName, in unsigned long aFlags, [optional] in jsval aOriginAttributes); [notxpcom] nsresult resolveNative(in AUTF8String aHostName, in unsigned long aFlags, in OriginAttributes aOriginAttributes, out nsIDNSRecord aResult); /** * The method takes a pointer to an nsTArray * and fills it with cache entry data * Called by the networking dashboard */ [noscript] void getDNSCacheEntries(in EntriesArray args); /** * Clears the DNS cache. * @param aTrrToo * If true we will clear TRR cached entries too. Since these * are resolved remotely it's not necessary to clear them when * the network status changes, but it's sometimes useful to do so * for tests or other situations. */ void clearCache(in boolean aTrrToo); /** * @return the hostname of the operating system. */ readonly attribute AUTF8String myHostName; /************************************************************************* * Listed below are the various flags that may be OR'd together to form * the aFlags parameter passed to asyncResolve() and resolve(). */ /** * if set, this flag suppresses the internal DNS lookup cache. */ const unsigned long RESOLVE_BYPASS_CACHE = (1 << 0); /** * if set, the canonical name of the specified host will be queried. */ const unsigned long RESOLVE_CANONICAL_NAME = (1 << 1); /** * if set, the query is given lower priority. Medium takes precedence * if both are used. */ const unsigned long RESOLVE_PRIORITY_MEDIUM = (1 << 2); const unsigned long RESOLVE_PRIORITY_LOW = (1 << 3); /** * if set, indicates request is speculative. Speculative requests * return errors if prefetching is disabled by configuration. */ const unsigned long RESOLVE_SPECULATE = (1 << 4); /** * If set, only IPv4 addresses will be returned from resolve/asyncResolve. */ const unsigned long RESOLVE_DISABLE_IPV6 = (1 << 5); /** * If set, only literals and cached entries will be returned from resolve/ * asyncResolve. */ const unsigned long RESOLVE_OFFLINE = (1 << 6); /** * If set, only IPv6 addresses will be returned from resolve/asyncResolve. */ const unsigned long RESOLVE_DISABLE_IPV4 = (1 << 7); /** * If set, allow name collision results (127.0.53.53) which are normally filtered. */ const unsigned long RESOLVE_ALLOW_NAME_COLLISION = (1 << 8); /** * If set, do not use TRR for resolving the host name. */ const unsigned long RESOLVE_DISABLE_TRR = (1 << 9); /** * if set (together with RESOLVE_BYPASS_CACHE), invalidate the DNS * existing cache entry first (if existing) then make a new resolve. */ const unsigned long RESOLVE_REFRESH_CACHE = (1 << 10); /** * This ure dns request types that are currently supported. * RESOLVE_TYPE_DEFAULT is standard A/AAAA lookup * The others (currently only TXT supported) are wireformat types */ const unsigned long RESOLVE_TYPE_DEFAULT = 0; const unsigned long RESOLVE_TYPE_TXT = 16; };