diff options
Diffstat (limited to 'dom/html/nsHTMLDNSPrefetch.h')
-rw-r--r-- | dom/html/nsHTMLDNSPrefetch.h | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/dom/html/nsHTMLDNSPrefetch.h b/dom/html/nsHTMLDNSPrefetch.h new file mode 100644 index 0000000000..11429e46c0 --- /dev/null +++ b/dom/html/nsHTMLDNSPrefetch.h @@ -0,0 +1,86 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* 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/. */ + +#ifndef nsHTMLDNSPrefetch_h___ +#define nsHTMLDNSPrefetch_h___ + +#include "nsCOMPtr.h" +#include "nsIRequest.h" +#include "nsString.h" +#include "nsWeakReference.h" + +class nsITimer; +namespace mozilla { + +class OriginAttributes; + +namespace dom { +class Document; +class Link; +} // namespace dom + +namespace net { +class NeckoParent; +} // namespace net +} // namespace mozilla + +class nsHTMLDNSPrefetch { + public: + // The required aDocument parameter is the context requesting the prefetch - + // under certain circumstances (e.g. headers, or security context) associated + // with the context the prefetch will not be performed. + static bool IsAllowed(mozilla::dom::Document* aDocument); + + static nsresult Initialize(); + static nsresult Shutdown(); + + // Call one of the Prefetch* methods to start the lookup. + // + // The URI versions will defer DNS lookup until pageload is + // complete, while the string versions submit the lookup to + // the DNS system immediately. The URI version is somewhat lighter + // weight, but its request is also more likely to be dropped due to a + // full queue and it may only be used from the main thread. + // + // If you are planning to use the methods with the OriginAttributes param, be + // sure that you pass a partitioned one. See StoragePrincipalHelper.h to know + // more. + + enum class Priority { + Low, + Medium, + High, + }; + static nsresult Prefetch(mozilla::dom::Link* aElement, Priority); + static nsresult Prefetch( + const nsAString& host, bool isHttps, + const mozilla::OriginAttributes& aPartitionedPrincipalOriginAttributes, + nsIRequest::TRRMode aTRRMode, Priority); + static nsresult CancelPrefetch( + const nsAString& host, bool isHttps, + const mozilla::OriginAttributes& aPartitionedPrincipalOriginAttributes, + nsIRequest::TRRMode aTRRMode, Priority, nsresult aReason); + static nsresult CancelPrefetch(mozilla::dom::Link* aElement, + Priority, nsresult aReason); + + static void LinkDestroyed(mozilla::dom::Link* aLink); + + private: + static uint32_t PriorityToDNSServiceFlags(Priority); + + static nsresult Prefetch( + const nsAString& host, bool isHttps, + const mozilla::OriginAttributes& aPartitionedPrincipalOriginAttributes, + uint32_t flags); + static nsresult CancelPrefetch( + const nsAString& hostname, bool isHttps, + const mozilla::OriginAttributes& aPartitionedPrincipalOriginAttributes, + uint32_t flags, nsresult aReason); + + friend class mozilla::net::NeckoParent; +}; + +#endif |