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
33namespace blink {
34
35PLATFORM_EXPORT extern const char errorDomainBlinkInternal[]; // Used for errors that won't be exposed to clients.
36
37class PLATFORM_EXPORT ResourceError {
38public:
39    static ResourceError cancelledError(const String& failingURL);
40
41    ResourceError()
42        : m_errorCode(0)
43        , m_isNull(true)
44        , m_isCancellation(false)
45        , m_isTimeout(false)
46        , m_staleCopyInCache(false)
47    {
48    }
49
50    ResourceError(const String& domain, int errorCode, const String& failingURL, const String& localizedDescription)
51        : m_domain(domain)
52        , m_errorCode(errorCode)
53        , m_failingURL(failingURL)
54        , m_localizedDescription(localizedDescription)
55        , m_isNull(false)
56        , m_isCancellation(false)
57        , m_isTimeout(false)
58        , m_staleCopyInCache(false)
59    {
60    }
61
62    // Makes a deep copy. Useful for when you need to use a ResourceError on another thread.
63    ResourceError copy() const;
64
65    bool isNull() const { return m_isNull; }
66
67    const String& domain() const { return m_domain; }
68    int errorCode() const { return m_errorCode; }
69    const String& failingURL() const { return m_failingURL; }
70    const String& localizedDescription() const { return m_localizedDescription; }
71
72    void setIsCancellation(bool isCancellation) { m_isCancellation = isCancellation; }
73    bool isCancellation() const { return m_isCancellation; }
74
75    void setIsTimeout(bool isTimeout) { m_isTimeout = isTimeout; }
76    bool isTimeout() const { return m_isTimeout; }
77    void setStaleCopyInCache(bool staleCopyInCache) { m_staleCopyInCache = staleCopyInCache; }
78    bool staleCopyInCache() const { return m_staleCopyInCache; }
79
80    static bool compare(const ResourceError&, const ResourceError&);
81
82private:
83    String m_domain;
84    int m_errorCode;
85    String m_failingURL;
86    String m_localizedDescription;
87    bool m_isNull;
88    bool m_isCancellation;
89    bool m_isTimeout;
90    bool m_staleCopyInCache;
91};
92
93inline bool operator==(const ResourceError& a, const ResourceError& b) { return ResourceError::compare(a, b); }
94inline bool operator!=(const ResourceError& a, const ResourceError& b) { return !(a == b); }
95
96} // namespace blink
97
98#endif // ResourceError_h
99