src/third_party/WebKit/public/web/WebEmbeddedWorker.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 WebEmbeddedWorker_h
  32 #define WebEmbeddedWorker_h
  33
  34 #include "public/platform/WebCommon.h"
  35
  36 namespace blink {
  37
  38 class WebServiceWorkerContextClient;
  39 class WebString;
  40 class WebWorkerPermissionClientProxy;
  41 struct WebEmbeddedWorkerStartData;
  42
  43 // An interface to start and terminate an embedded worker.
  44 // All methods of this class must be called on the main thread.
  45 class WebEmbeddedWorker {
  46 public:
  47     // Invoked on the main thread to instantiate a WebEmbeddedWorker.
  48     // The given WebWorkerContextClient and WebWorkerPermissionClientProxy are
  49     // going to be passed on to the worker thread and is held by a newly
  50     // created WorkerGlobalScope.
  51     BLINK_EXPORT static WebEmbeddedWorker* create(
  52         WebServiceWorkerContextClient*,
  53         WebWorkerPermissionClientProxy*);
  54
  55     virtual ~WebEmbeddedWorker() { }
  56
  57     // Starts and terminates WorkerThread and WorkerGlobalScope.
  58     virtual void startWorkerContext(const WebEmbeddedWorkerStartData&) = 0;
  59     virtual void terminateWorkerContext() = 0;
  60
  61     // Resumes starting a worker startup that was paused via
  62     // WebEmbeddedWorkerStartData.pauseAfterDownloadMode.
  63     virtual void resumeAfterDownload() = 0;
  64
  65     // Inspector related methods.
  66     virtual void resumeWorkerContext() = 0;
  67     virtual void attachDevTools(const WebString& hostId) = 0;
  68     virtual void reattachDevTools(const WebString& hostId, const WebString& savedState) = 0;
  69     virtual void detachDevTools() = 0;
  70     virtual void dispatchDevToolsMessage(const WebString&) = 0;
  71 };
  72
  73 } // namespace blink
  74
  75 #endif // WebEmbeddedWorker_h