platform/WebURLError.h

/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 WebURLError_h
#define WebURLError_h

#include "WebString.h"
#include "WebURL.h"

namespace blink {

class ResourceError;

struct WebURLError {
    // A namespace for "reason" to support various layers generating
    // resource errors. WebKit does not care about the value of this
    // string as it will just be passed via callbacks to the consumer.
    WebString domain;

    // A numeric error code detailing the reason for this error. A value
    // of 0 means no error. WebKit does not interpret the meaning of other
    // values and normally just forwards this error information back to the
    // embedder (see for example WebFrameClient).
    int reason;

    // A flag showing whether or not "unreachableURL" has a copy in the
    // cache that was too stale to return for this request.
    bool staleCopyInCache;

    // A flag showing whether this error should be treated as a cancellation,
    // e.g. we do not show console errors for cancellations.
    bool isCancellation;

    // A flag showing whether this error is the result of a request being
    // ignored (e.g. through shouldOverrideUrlLoading).
    bool wasIgnoredByHandler;

    // The url that failed to load.
    WebURL unreachableURL;

    // A description for the error.
    WebString localizedDescription;

    WebURLError() : reason(0), staleCopyInCache(false), isCancellation(false),
        wasIgnoredByHandler(false) { }

#if INSIDE_BLINK
    BLINK_PLATFORM_EXPORT WebURLError(const ResourceError&);
    BLINK_PLATFORM_EXPORT WebURLError& operator=(const ResourceError&);
    BLINK_PLATFORM_EXPORT operator ResourceError() const;
#endif
};

} // namespace blink

#endif