chrome/browser/extensions/api/api_resource.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_EXTENSIONS_API_API_RESOURCE_H_
   6 #define CHROME_BROWSER_EXTENSIONS_API_API_RESOURCE_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "content/public/browser/browser_thread.h"
  11 #include "extensions/common/extension.h"
  12
  13 namespace extensions {
  14
  15 // An ApiResource represents something that an extension API manages, such as a
  16 // socket or a serial-port connection. Typically, an ApiResourceManager will
  17 // control the lifetime of all ApiResources of a specific derived type.
  18 class ApiResource {
  19  public:
  20   virtual ~ApiResource();
  21
  22   const std::string& owner_extension_id() const {
  23     return owner_extension_id_;
  24   }
  25
  26   // If this method returns |true|, the resource remains open when the
  27   // owning extension is suspended due to inactivity.
  28   virtual bool IsPersistent() const;
  29
  30   static const content::BrowserThread::ID kThreadId =
  31       content::BrowserThread::IO;
  32
  33  protected:
  34   explicit ApiResource(const std::string& owner_extension_id);
  35
  36  private:
  37   // The extension that owns this resource.
  38   const std::string owner_extension_id_;
  39
  40   DISALLOW_COPY_AND_ASSIGN(ApiResource);
  41 };
  42
  43 }  // namespace extensions
  44
  45 #endif  // CHROME_BROWSER_EXTENSIONS_API_API_RESOURCE_H_