src/third_party/WebKit/public/platform/WebServiceWorker.h

   1 /*
   2  * Copyright (C) 2013 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 WebServiceWorker_h
  32 #define WebServiceWorker_h
  33
  34 #include "WebCommon.h"
  35 #include "WebMessagePortChannel.h"
  36 #include "WebServiceWorkerState.h"
  37 #include "WebString.h"
  38 #include "WebURL.h"
  39 #include "WebVector.h"
  40
  41 namespace blink {
  42
  43 class WebServiceWorkerProxy;
  44 typedef WebVector<class WebMessagePortChannel*> WebMessagePortChannelArray;
  45
  46 class WebServiceWorker {
  47 public:
  48     virtual ~WebServiceWorker() { }
  49
  50     // Sets ServiceWorkerProxy, with which callee can start making upcalls
  51     // to the ServiceWorker object via the client. This doesn't pass the
  52     // ownership to the callee, and the proxy's lifetime is same as that of
  53     // WebServiceWorker.
  54     virtual void setProxy(WebServiceWorkerProxy*) { }
  55
  56     // Called by this worker's ServiceWorkerProxy when it has become ready or
  57     // not ready for state change notifications.
  58     virtual void proxyReadyChanged() { }
  59
  60     virtual WebURL scope() const { return WebURL(); }
  61     virtual WebURL url() const { return WebURL(); }
  62     virtual WebServiceWorkerState state() const { return WebServiceWorkerStateUnknown; }
  63
  64     // Callee receives ownership of the passed vector.
  65     // FIXME: Blob refs should be passed to maintain ref counts. crbug.com/351753
  66     virtual void postMessage(const WebString&, WebMessagePortChannelArray*) { BLINK_ASSERT_NOT_REACHED(); }
  67 };
  68
  69 }
  70
  71 #endif // WebServiceWorker_h