netwerk/base/nsDNSPrefetch.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef nsDNSPrefetch_h___
   7 #define nsDNSPrefetch_h___
   8
   9 #include <functional>
  10
  11 #include "nsIWeakReferenceUtils.h"
  12 #include "nsString.h"
  13 #include "mozilla/TimeStamp.h"
  14 #include "mozilla/Attributes.h"
  15 #include "mozilla/BasePrincipal.h"
  16
  17 #include "nsIDNSListener.h"
  18 #include "nsIRequest.h"
  19 #include "nsIDNSService.h"
  20
  21 class nsIURI;
  22 class nsIDNSHTTPSSVCRecord;
  23
  24 class nsDNSPrefetch final : public nsIDNSListener {
  25   ~nsDNSPrefetch() = default;
  26
  27  public:
  28   NS_DECL_THREADSAFE_ISUPPORTS
  29   NS_DECL_NSIDNSLISTENER
  30
  31   nsDNSPrefetch(nsIURI* aURI, mozilla::OriginAttributes& aOriginAttributes,
  32                 nsIRequest::TRRMode aTRRMode, nsIDNSListener* aListener,
  33                 bool storeTiming);
  34   // For fetching HTTPS RR.
  35   nsDNSPrefetch(nsIURI* aURI, mozilla::OriginAttributes& aOriginAttributes,
  36                 nsIRequest::TRRMode aTRRMode);
  37   bool TimingsValid() const {
  38     return !mStartTimestamp.IsNull() && !mEndTimestamp.IsNull();
  39   }
  40   // Only use the two timings if TimingsValid() returns true
  41   const mozilla::TimeStamp& StartTimestamp() const { return mStartTimestamp; }
  42   const mozilla::TimeStamp& EndTimestamp() const { return mEndTimestamp; }
  43
  44   static nsresult Initialize(nsIDNSService* aDNSService);
  45   static nsresult Shutdown();
  46
  47   // Call one of the following methods to start the Prefetch.
  48   nsresult PrefetchHigh(
  49       nsIDNSService::DNSFlags = nsIDNSService::RESOLVE_DEFAULT_FLAGS);
  50   nsresult PrefetchMedium(
  51       nsIDNSService::DNSFlags = nsIDNSService::RESOLVE_DEFAULT_FLAGS);
  52   nsresult PrefetchLow(
  53       nsIDNSService::DNSFlags = nsIDNSService::RESOLVE_DEFAULT_FLAGS);
  54
  55   nsresult FetchHTTPSSVC(
  56       bool aRefreshDNS, bool aPrefetch,
  57       std::function<void(nsIDNSHTTPSSVCRecord*)>&& aCallback);
  58
  59  private:
  60   nsCString mHostname;
  61   int32_t mPort{-1};
  62   mozilla::OriginAttributes mOriginAttributes;
  63   bool mStoreTiming;
  64   nsIRequest::TRRMode mTRRMode;
  65   mozilla::TimeStamp mStartTimestamp;
  66   mozilla::TimeStamp mEndTimestamp;
  67   nsWeakPtr mListener;
  68
  69   nsresult Prefetch(nsIDNSService::DNSFlags flags);
  70 };
  71
  72 #endif