third_party/WebKit/Source/platform/network/ResourceError.h

   1 /*
   2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
   3  * Copyright (C) 2013 Google Inc.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef ResourceError_h
  28 #define ResourceError_h
  29
  30 #include "platform/PlatformExport.h"
  31 #include "wtf/text/WTFString.h"
  32
  33 namespace blink {
  34
  35 PLATFORM_EXPORT extern const char errorDomainBlinkInternal[]; // Used for errors that won't be exposed to clients.
  36
  37 class PLATFORM_EXPORT ResourceError {
  38 public:
  39     static ResourceError cancelledError(const String& failingURL);
  40     static ResourceError cancelledDueToAccessCheckError(const String& failingURL);
  41
  42     ResourceError()
  43         : m_errorCode(0)
  44         , m_isNull(true)
  45         , m_isCancellation(false)
  46         , m_isAccessCheck(false)
  47         , m_isTimeout(false)
  48         , m_staleCopyInCache(false)
  49         , m_wasIgnoredByHandler(false)
  50     {
  51     }
  52
  53     ResourceError(const String& domain, int errorCode, const String& failingURL, const String& localizedDescription)
  54         : m_domain(domain)
  55         , m_errorCode(errorCode)
  56         , m_failingURL(failingURL)
  57         , m_localizedDescription(localizedDescription)
  58         , m_isNull(false)
  59         , m_isCancellation(false)
  60         , m_isAccessCheck(false)
  61         , m_isTimeout(false)
  62         , m_staleCopyInCache(false)
  63         , m_wasIgnoredByHandler(false)
  64     {
  65     }
  66
  67     // Makes a deep copy. Useful for when you need to use a ResourceError on another thread.
  68     ResourceError copy() const;
  69
  70     bool isNull() const { return m_isNull; }
  71
  72     const String& domain() const { return m_domain; }
  73     int errorCode() const { return m_errorCode; }
  74     const String& failingURL() const { return m_failingURL; }
  75     const String& localizedDescription() const { return m_localizedDescription; }
  76
  77     void setIsCancellation(bool isCancellation) { m_isCancellation = isCancellation; }
  78     bool isCancellation() const { return m_isCancellation; }
  79
  80     void setIsAccessCheck(bool isAccessCheck) { m_isAccessCheck = isAccessCheck; }
  81     bool isAccessCheck() const { return m_isAccessCheck; }
  82
  83     void setIsTimeout(bool isTimeout) { m_isTimeout = isTimeout; }
  84     bool isTimeout() const { return m_isTimeout; }
  85     void setStaleCopyInCache(bool staleCopyInCache) { m_staleCopyInCache = staleCopyInCache; }
  86     bool staleCopyInCache() const { return m_staleCopyInCache; }
  87
  88     void setWasIgnoredByHandler(bool ignoredByHandler) { m_wasIgnoredByHandler = ignoredByHandler; }
  89     bool wasIgnoredByHandler() const { return m_wasIgnoredByHandler; }
  90
  91     static bool compare(const ResourceError&, const ResourceError&);
  92
  93 private:
  94     String m_domain;
  95     int m_errorCode;
  96     String m_failingURL;
  97     String m_localizedDescription;
  98     bool m_isNull;
  99     bool m_isCancellation;
 100     bool m_isAccessCheck;
 101     bool m_isTimeout;
 102     bool m_staleCopyInCache;
 103     bool m_wasIgnoredByHandler;
 104 };
 105
 106 inline bool operator==(const ResourceError& a, const ResourceError& b) { return ResourceError::compare(a, b); }
 107 inline bool operator!=(const ResourceError& a, const ResourceError& b) { return !(a == b); }
 108
 109 } // namespace blink
 110
 111 #endif // ResourceError_h