third_party/WebKit/public/web/WebSharedWorker.h

   1 /*
   2  * Copyright (C) 2009 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 WebSharedWorker_h
  32 #define WebSharedWorker_h
  33
  34 #include "../platform/WebCommon.h"
  35 #include "WebContentSecurityPolicy.h"
  36
  37 namespace blink {
  38
  39 class WebString;
  40 class WebMessagePortChannel;
  41 class WebSharedWorkerClient;
  42 class WebURL;
  43
  44 // This is the interface to a SharedWorker thread.
  45 class WebSharedWorker {
  46 public:
  47     // Instantiate a WebSharedWorker that interacts with the shared worker.
  48     // WebSharedWorkerClient given here must outlive or have the identical
  49     // lifetime as this instance.
  50     BLINK_EXPORT static WebSharedWorker* create(WebSharedWorkerClient*);
  51
  52     virtual void startWorkerContext(
  53         const WebURL& scriptURL,
  54         const WebString& name,
  55         const WebString& contentSecurityPolicy,
  56         WebContentSecurityPolicyType) = 0;
  57
  58     // Sends a connect event to the SharedWorker context.
  59     virtual void connect(WebMessagePortChannel*) = 0;
  60
  61     // Invoked to shutdown the worker when there are no more associated documents. This eventually deletes this instance.
  62     virtual void terminateWorkerContext() = 0;
  63
  64     virtual void pauseWorkerContextOnStart() = 0;
  65     virtual void attachDevTools(const WebString& hostId) = 0;
  66     virtual void reattachDevTools(const WebString& hostId, const WebString& savedState) = 0;
  67     virtual void detachDevTools() = 0;
  68     virtual void dispatchDevToolsMessage(const WebString&) = 0;
  69 };
  70
  71 } // namespace blink
  72
  73 #endif