third_party/WebKit/public/web/WebImageCache.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 WebImageCache_h
  32 #define WebImageCache_h
  33
  34 #include "../platform/WebCommon.h"
  35
  36 namespace blink {
  37
  38 // An interface to query and configure WebKit's image cache.
  39 //
  40 // Methods of this interface can be called on any thread.
  41 //
  42 // Methods of this interface can be only be used after blink::initialize()
  43 // and before blink::shutdown() is called.
  44
  45 class WebImageCache {
  46 public:
  47     // Sets the capacities of the image cache, evicting objects as necessary.
  48     BLINK_EXPORT static void setCacheLimitInBytes(size_t);
  49
  50     // Clears the cache (as much as possible; some resources may not be
  51     // cleared if they are actively referenced).
  52     BLINK_EXPORT static void clear();
  53
  54     // Returns the number of bytes used by the cache.
  55     BLINK_EXPORT static size_t memoryUsageInBytes();
  56
  57     // Returns the number of cached entries.
  58     BLINK_EXPORT static unsigned cacheEntries();
  59
  60 private:
  61     WebImageCache();  // Not intended to be instanced.
  62 };
  63
  64 }  // namespace blink
  65
  66 #endif