third_party/WebKit/public/web/modules/serviceworker/WebServiceWorkerNetworkProvider.h

   1 /*
   2  * Copyright (C) 2014 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebServiceWorkerNetworkProvider_h
  32 #define WebServiceWorkerNetworkProvider_h
  33
  34 namespace blink {
  35
  36 class WebDataSource;
  37 class WebURLRequest;
  38
  39 // This interface is implemented by the client and is only called on the main thread.
  40 // Used by ServiceWorker and SharedWorker. isControlledByServiceWorker() and
  41 // serviceWorkerID() are to be implemented only by SharedWorker's provider,
  42 // as they are needed only for controllee workers.
  43 class WebServiceWorkerNetworkProvider {
  44 public:
  45     virtual ~WebServiceWorkerNetworkProvider() { }
  46
  47     // A request is about to be sent out, and the client may modify it. Request
  48     // is writable, and changes to the URL, for example, will change the request
  49     // made.
  50     virtual void willSendRequest(WebDataSource*, WebURLRequest&) { }
  51
  52     // Whether the document associated with WebDataSource is controlled by the
  53     // ServiceWorker.
  54     virtual bool isControlledByServiceWorker(WebDataSource&) { return false; }
  55
  56     // Returns an identifier of the service worker controlling the document
  57     // associated with the WebDataSource.
  58     virtual int64_t serviceWorkerID(WebDataSource&) { return -1; }
  59 };
  60
  61 } // namespace blink
  62
  63 #endif // WebServiceWorkerNetworkProvider_h