diff options
Diffstat (limited to 'dom/base/nsSyncLoadService.h')
-rw-r--r-- | dom/base/nsSyncLoadService.h | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/dom/base/nsSyncLoadService.h b/dom/base/nsSyncLoadService.h new file mode 100644 index 0000000000..682807ef10 --- /dev/null +++ b/dom/base/nsSyncLoadService.h @@ -0,0 +1,72 @@ +/* -*- 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/. */ + +/* + * A service that provides methods for synchronously loading a DOM in various + * ways. + */ + +#ifndef nsSyncLoadService_h__ +#define nsSyncLoadService_h__ + +#include "mozilla/AlreadyAddRefed.h" +#include "nscore.h" +#include "nsIContentPolicy.h" +#include "nsILoadInfo.h" +#include "nsIReferrerInfo.h" + +class nsICookieJarSettings; +class nsIInputStream; +class nsILoadGroup; +class nsIStreamListener; +class nsIURI; +class nsIPrincipal; +class nsIChannel; + +namespace mozilla { +namespace dom { +class Document; +} +} // namespace mozilla + +class nsSyncLoadService { + public: + /** + * Synchronously load the document from the specified URI. + * + * @param aURI URI to load the document from. + * @param aContentPolicyType contentPolicyType to be set on the channel + * @param aLoaderPrincipal Principal of loading document. For security + * checks and referrer header. + * @param aSecurityFlags securityFlags to be set on the channel + * @param aLoadGroup The loadgroup to use for loading the document. + * @param aForceToXML Whether to parse the document as XML, regardless of + * content type. + * @param referrerPolicy Referrer policy. + * @param aResult [out] The document loaded from the URI. + */ + static nsresult LoadDocument( + nsIURI* aURI, nsContentPolicyType aContentPolicyType, + nsIPrincipal* aLoaderPrincipal, nsSecurityFlags aSecurityFlags, + nsILoadGroup* aLoadGroup, nsICookieJarSettings* aCookieJarSettings, + bool aForceToXML, mozilla::dom::ReferrerPolicy aReferrerPolicy, + mozilla::dom::Document** aResult); + + /** + * Read input stream aIn in chunks and deliver synchronously to aListener. + * + * @param aIn The stream to be read. The ownership of this stream is taken. + * @param aListener The listener that will receive + * OnStartRequest/OnDataAvailable/OnStopRequest + * notifications. + * @param aChannel The channel that aIn was opened from. + */ + static nsresult PushSyncStreamToListener(already_AddRefed<nsIInputStream> aIn, + nsIStreamListener* aListener, + nsIChannel* aChannel); +}; + +#endif // nsSyncLoadService_h__ |