content/browser/renderer_host/navigation_discard_reason.h

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_DISCARD_REASON_H_
#define CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_DISCARD_REASON_H_

// Used to annotate the reason for calling into methods that delete speculative
// RenderFrameHosts or ongoing NavigationRequests. Purely informational for now,
// but in the future, intended to serve as a signal for how a caller of the
// functions should handle cases when the speculative RenderFrameHost cannot be
// promptly discarded. See https://crbug.com/1220337 for more info.
enum class NavigationDiscardReason {
  // A new navigation will start and replace a pre-existing navigation. This
  // resets any NavigationRequest and speculative RenderFrameHost on the
  // targeted FrameTreeNode.
  kNewNavigation,
  // The FrameTreeNode the navigation targets is being removed, e.g. user closed
  // the tab or script removed the frame owner element from its container
  // document.
  kWillRemoveFrame,
  // Ongoing navigations have been cancelled, e.g. the user clicked Stop.
  kCancelled,
  // In certain cases when a navigation commits in a FrameTreeNode, other
  // navigation attempts targeting the same FrameTreeNode are cancelled.
  kCommittedNavigation,
  // The render process is gone, typically due to a crash.
  kRenderProcessGone,
  // The RenderFrameHost containing the NavigationRequest is destructed.
  // This is only used by the RenderFrameHost destructor, and typically other
  // navigation cancellations will cancel the navigations on the RFH separately
  // with a more specific reason before destructing the RenderFrameHost.
  kRenderFrameHostDestruction,
};

#endif  // CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_DISCARD_REASON_H_