third_party/WebKit/public/platform/WebURLError.h

   1 /*
   2  * Copyright (C) 2009 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 WebURLError_h
  32 #define WebURLError_h
  33
  34 #include "WebString.h"
  35 #include "WebURL.h"
  36
  37 namespace blink {
  38
  39 class ResourceError;
  40
  41 struct WebURLError {
  42     // A namespace for "reason" to support various layers generating
  43     // resource errors. WebKit does not care about the value of this
  44     // string as it will just be passed via callbacks to the consumer.
  45     WebString domain;
  46
  47     // A numeric error code detailing the reason for this error. A value
  48     // of 0 means no error. WebKit does not interpret the meaning of other
  49     // values and normally just forwards this error information back to the
  50     // embedder (see for example WebFrameClient).
  51     int reason;
  52
  53     // A flag showing whether or not "unreachableURL" has a copy in the
  54     // cache that was too stale to return for this request.
  55     bool staleCopyInCache;
  56
  57     // A flag showing whether this error should be treated as a cancellation,
  58     // e.g. we do not show console errors for cancellations.
  59     bool isCancellation;
  60
  61     // A flag showing whether this error is the result of a request being
  62     // ignored (e.g. through shouldOverrideUrlLoading).
  63     bool wasIgnoredByHandler;
  64
  65     // The url that failed to load.
  66     WebURL unreachableURL;
  67
  68     // A description for the error.
  69     WebString localizedDescription;
  70
  71     WebURLError() : reason(0), staleCopyInCache(false), isCancellation(false),
  72         wasIgnoredByHandler(false) { }
  73
  74 #if INSIDE_BLINK
  75     BLINK_PLATFORM_EXPORT WebURLError(const ResourceError&);
  76     BLINK_PLATFORM_EXPORT WebURLError& operator=(const ResourceError&);
  77     BLINK_PLATFORM_EXPORT operator ResourceError() const;
  78 #endif
  79 };
  80
  81 } // namespace blink
  82
  83 #endif