Interface nsIDNSServiceType

nsIDNSService

Hierarchy

Properties

ODoHActivated currentTrrConfirmationState currentTrrMode currentTrrURI heuristicDetectionResult myHostName trrDomain

Methods

AddRef IsSVCDomainNameFailed QueryInterface Release ReportFailedSVCDomainName ResetExcludedSVCDomainName asyncResolve asyncResolveNative cancelAsyncResolve cancelAsyncResolveNative clearCache getDNSCacheEntries getTRRSkipReasonName newAdditionalInfo reloadParentalControlEnabled resolve resolveNative setDetectedTrrURI setHeuristicDetectionResult setTRRModeInChild

Properties

Readonly ODoHActivated

ODoHActivated: boolean

Returns true when we have valid ODoHConfigs to encrypt/decrypt oblivious DNS packets.

Readonly currentTrrConfirmationState

currentTrrConfirmationState: number

The TRRService's current confirmation state. This is mostly for testing purposes.

Readonly currentTrrMode

currentTrrMode: nsIDNSService_ResolverMode

Returns the value of the TRR Service's current default mode.

Readonly currentTrrURI

currentTrrURI: string

Returns a string containing the URI currently used by the TRR service.

Readonly heuristicDetectionResult

heuristicDetectionResult: nsITRRSkipReason_value

Returns the result of the last TRR heuristic detection. Will be TRR_OK if no heuristics failed.

Readonly myHostName

myHostName: string

Returns

the hostname of the operating system.

Readonly trrDomain

trrDomain: string

returns the current TRR domain.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

IsSVCDomainNameFailed

  • Check if the given domain name was failed to connect to before.

    Parameters

    • aOwnerName: string

      The owner name of this HTTPS RRs.

    • aSVCDomainName: string

      The domain name of this alternative endpoint.

    Returns boolean

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

ReportFailedSVCDomainName

  • Notifies the DNS service that we failed to connect to this alternative endpoint.

    Parameters

    • aOwnerName: string

      The owner name of this HTTPS RRs.

    • aSVCDomainName: string

      The domain name of this alternative endpoint.

    Returns void

ResetExcludedSVCDomainName

  • Reset the exclusion list.

    Parameters

    • aOwnerName: string

      The owner name of this HTTPS RRs.

    Returns void

asyncResolve

  • kicks off an asynchronous host lookup.

    Returns

    An object that can be used to cancel the host lookup.

    Parameters

    • aHostName: string

      the hostname or IP-address-literal to resolve.

    • aType: nsIDNSService_ResolveType

      one of RESOLVE_TYPE_*.

    • aFlags: nsIDNSService_DNSFlags

      a bitwise OR of the RESOLVE_ prefixed constants defined below.

    • aInfo: nsIDNSAdditionalInfo

      a AdditionalInfo object that holds information about:

      • the resolver to be used such as TRR URL
      • the port number that could be used to construct a QNAME for HTTPS RR If null we use the default configuration.
    • aListener: nsIDNSListener

      the listener to be notified when the result is available.

    • aListenerTarget: nsIEventTarget

      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).

    • aOriginAttributes: any

      the originAttribute for this resolving, the DNS cache will be separated according to this originAttributes. This attribute is optional to avoid breaking add-ons.

    Returns nsICancelable

asyncResolveNative

  • Parameters

    • aHostName: string
    • aType: nsIDNSService_ResolveType
    • aFlags: nsIDNSService_DNSFlags
    • aInfo: nsIDNSAdditionalInfo
    • aListener: nsIDNSListener
    • aListenerTarget: nsIEventTarget
    • aOriginAttributes: OriginAttributes
    • aResult: nsICancelable

    Returns number

cancelAsyncResolve

  • Attempts to cancel a previously requested async DNS lookup

    Parameters

    • aHostName: string

      the hostname or IP-address-literal to resolve.

    • aType: nsIDNSService_ResolveType

      one of RESOLVE_TYPE_*.

    • aFlags: nsIDNSService_DNSFlags

      a bitwise OR of the RESOLVE_ prefixed constants defined below.

    • aResolver: nsIDNSAdditionalInfo
    • aListener: nsIDNSListener

      the original listener which was to be notified about the host lookup result - used to match request information to requestor.

    • aReason: number

      nsresult reason for the cancellation

    • aOriginAttributes: any

      the originAttribute for this resolving. This attribute is optional to avoid breaking add-ons.

    Returns void

cancelAsyncResolveNative

  • Parameters

    • aHostName: string
    • aType: nsIDNSService_ResolveType
    • aFlags: nsIDNSService_DNSFlags
    • aResolver: nsIDNSAdditionalInfo
    • aListener: nsIDNSListener
    • aReason: number
    • aOriginAttributes: OriginAttributes

    Returns number

clearCache

  • Clears the DNS cache.

    Parameters

    • aTrrToo: boolean

      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.

    Returns void

getDNSCacheEntries

  • The method takes a pointer to an nsTArray and fills it with cache entry data Called by the networking dashboard

    Parameters

    • args: EntriesArray

    Returns void

getTRRSkipReasonName

  • Parameters

    • value: nsITRRSkipReason_value

    Returns string

newAdditionalInfo

  • Returns a new nsIDNSAdditionalInfo object containing the URL we pass to it.

    Parameters

    • aTrrURL: string
    • aPort: int32_t

    Returns nsIDNSAdditionalInfo

reloadParentalControlEnabled

  • The method is used only for test purpose. We use this to recheck if parental control is enabled or not.

    Returns void

resolve

  • 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.

    Returns

    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.

    Parameters

    • aHostName: string

      the hostname or IP-address-literal to resolve.

    • aFlags: nsIDNSService_DNSFlags

      a bitwise OR of the RESOLVE_ prefixed constants defined below.

    • aOriginAttributes: any

      the originAttribute for this resolving, the DNS cache will be separated according to this originAttributes. This attribute is optional to avoid breaking add-ons.

    Returns nsIDNSRecord

resolveNative

  • Parameters

    • aHostName: string
    • aFlags: nsIDNSService_DNSFlags
    • aOriginAttributes: OriginAttributes
    • aResult: nsIDNSRecord

    Returns number

setDetectedTrrURI

  • Notifies the TRR service of a TRR that was automatically detected based on network preferences.

    Parameters

    • aURI: string

    Returns void

setHeuristicDetectionResult

  • Stores the result of the TRR heuristic detection. Will be TRR_OK if no heuristics failed.

    Parameters

    • value: nsITRRSkipReason_value

    Returns void

setTRRModeInChild

  • Parameters

    • mode: nsIDNSService_ResolverMode

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc