Source/WebCore/workers/SharedWorkerRepository.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 SharedWorkerRepository_h
  32 #define SharedWorkerRepository_h
  33
  34 #if ENABLE(SHARED_WORKERS)
  35
  36 #include <wtf/Forward.h>
  37 #include <wtf/PassOwnPtr.h>
  38 #include <wtf/PassRefPtr.h>
  39
  40 namespace WebCore {
  41
  42     class Document;
  43     class KURL;
  44     class MessagePortChannel;
  45     class SharedWorker;
  46
  47     typedef int ExceptionCode;
  48
  49     // Interface to a repository which manages references to the set of active shared workers.
  50     class SharedWorkerRepository {
  51     public:
  52         // Returns true if the platform supports SharedWorkers, otherwise false.
  53         static bool isAvailable();
  54
  55         // Connects the passed SharedWorker object with the specified worker thread, creating a new thread if necessary.
  56         static void connect(PassRefPtr<SharedWorker>, PassOwnPtr<MessagePortChannel>, const KURL&, const String& name, ExceptionCode&);
  57
  58         // Invoked when a document has been detached.
  59         static void documentDetached(Document*);
  60
  61         // Returns true if the passed document is associated with any SharedWorkers.
  62         static bool hasSharedWorkers(Document*);
  63     private:
  64         SharedWorkerRepository() { }
  65     };
  66
  67 } // namespace WebCore
  68
  69 #endif // ENABLE(SHARED_WORKERS)
  70
  71 #endif // SharedWorkerRepository_h