Home | History | Annotate | Download | only in network 
      1 /*
      2  * Copyright (C) 2006 Apple Computer, 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
      6  * are met:
      7  * 1. Redistributions of source code must retain the above copyright
      8  *    notice, this list of conditions and the following disclaimer.
      9  * 2. Redistributions in binary form must reproduce the above copyright
     10  *    notice, this list of conditions and the following disclaimer in the
     11  *    documentation and/or other materials provided with the distribution.
     12  *
     13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef ResourceHandleClient_h
     27 #define ResourceHandleClient_h
     28 
     29 #include <wtf/RefCounted.h>
     30 #include <wtf/Platform.h>
     31 #include <wtf/RefPtr.h>
     32 
     33 #if USE(CFNETWORK)
     34 #include <ConditionalMacros.h>
     35 #include <CFNetwork/CFURLCachePriv.h>
     36 #include <CFNetwork/CFURLResponsePriv.h>
     37 #endif
     38 
     39 #if PLATFORM(MAC)
     40 #ifdef __OBJC__
     41 @class NSCachedURLResponse;
     42 #else
     43 class NSCachedURLResponse;
     44 #endif
     45 #endif
     46 
     47 namespace WebCore {
     48     class AuthenticationChallenge;
     49     class Credential;
     50     class KURL;
     51     class ResourceHandle;
     52     class ResourceError;
     53     class ResourceRequest;
     54     class ResourceResponse;
     55 
     56     enum CacheStoragePolicy {
     57         StorageAllowed,
     58         StorageAllowedInMemoryOnly,
     59         StorageNotAllowed,
     60     };
     61 
     62     class ResourceHandleClient {
     63     public:
     64         virtual ~ResourceHandleClient() { }
     65 
     66         // request may be modified
     67         virtual void willSendRequest(ResourceHandle*, ResourceRequest&, const ResourceResponse& /*redirectResponse*/) { }
     68         virtual void didSendData(ResourceHandle*, unsigned long long /*bytesSent*/, unsigned long long /*totalBytesToBeSent*/) { }
     69 
     70         virtual void didReceiveResponse(ResourceHandle*, const ResourceResponse&) { }
     71         virtual void didReceiveData(ResourceHandle*, const char*, int, int /*lengthReceived*/) { }
     72         virtual void didFinishLoading(ResourceHandle*) { }
     73         virtual void didFail(ResourceHandle*, const ResourceError&) { }
     74         virtual void wasBlocked(ResourceHandle*) { }
     75         virtual void cannotShowURL(ResourceHandle*) { }
     76 
     77         virtual void willCacheResponse(ResourceHandle*, CacheStoragePolicy&) { }
     78 
     79         virtual bool shouldUseCredentialStorage(ResourceHandle*) { return false; }
     80         virtual void didReceiveAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) { }
     81         virtual void didCancelAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) { }
     82         virtual void receivedCancellation(ResourceHandle*, const AuthenticationChallenge&) { }
     83 
     84 #if PLATFORM(MAC)
     85         virtual NSCachedURLResponse* willCacheResponse(ResourceHandle*, NSCachedURLResponse* response) { return response; }
     86         virtual void willStopBufferingData(ResourceHandle*, const char*, int) { }
     87 #endif
     88 #if USE(CFNETWORK)
     89         virtual bool shouldCacheResponse(ResourceHandle*, CFCachedURLResponseRef response) { return true; }
     90 #endif
     91     };
     92 
     93 }
     94 
     95 #endif
     96