Source/WebKit/android/WebCoreSupport/WebCache.h

/*
 * Copyright 2010, The Android Open Source Project
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebCache_h
#define WebCache_h

#include "CacheResult.h"
#include "ChromiumIncludes.h"

#include <OwnPtr.h>
#include <platform/text/PlatformString.h>
#include <wtf/ThreadingPrimitives.h>

namespace android {

// This class is not generally threadsafe. However, get() and cleanup() are
// threadsafe.
class WebCache : public base::RefCountedThreadSafe<WebCache> {
public:
    static WebCache* get(bool isPrivateBrowsing);
    static void cleanup(bool isPrivateBrowsing);

    void clear();
    scoped_refptr<CacheResult> getCacheResult(WTF::String url);
    net::HostResolver* hostResolver() { return m_hostResolver.get(); }
    net::HttpCache* cache() { return m_cache.get(); }
    net::ProxyConfigServiceAndroid* proxy() { return m_proxyConfigService; }
    void closeIdleConnections();


private:
    WebCache(bool isPrivateBrowsing);

    // For clear()
    void clearImpl();
    void doomAllEntries(int);
    void onClearDone(int);

    // For closeIdleConnections
    void closeIdleImpl();

    // For getEntry()
    void getEntryImpl();
    void openEntry(int);
    void onGetEntryDone(int);

    OwnPtr<net::HostResolver> m_hostResolver;
    OwnPtr<net::HttpCache> m_cache;
    // This is owned by the ProxyService, which is owned by the HttpNetworkLayer,
    // which is owned by the HttpCache, which is owned by this class.
    net::ProxyConfigServiceAndroid* m_proxyConfigService;

    // For clear()
    net::CompletionCallbackImpl<WebCache> m_doomAllEntriesCallback;
    net::CompletionCallbackImpl<WebCache> m_onClearDoneCallback;
    bool m_isClearInProgress;
    // For getEntry()
    net::CompletionCallbackImpl<WebCache> m_openEntryCallback;
    net::CompletionCallbackImpl<WebCache> m_onGetEntryDoneCallback;
    bool m_isGetEntryInProgress;
    String m_entryUrl;
    disk_cache::Entry* m_entry;
    WTF::Mutex m_getEntryMutex;
    WTF::ThreadCondition m_getEntryCondition;

    disk_cache::Backend* m_cacheBackend;
};

} // namespace android

#endif