1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_
#define CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_
#include "content/public/browser/navigation_handle.h"
#include "base/macros.h"
#include "base/memory/scoped_ptr.h"
#include "content/common/content_export.h"
#include "url/gurl.h"
namespace content {
class NavigatorDelegate;
struct NavigationRequestInfo;
// This class keeps track of a single navigation. It is created upon receipt of
// a DidStartProvisionalLoad IPC in a RenderFrameHost. The RenderFrameHost owns
// the newly created NavigationHandleImpl as long as the navigation is ongoing.
// The NavigationHandleImpl in the RenderFrameHost will be reset when the
// navigation stops, that is if one of the following events happen:
// - The RenderFrameHost receives a DidStartProvisionalLoad IPC for a new
// navigation (see below for special cases where the DidStartProvisionalLoad
// message does not indicate the start of a new navigation).
// - The RenderFrameHost stops loading.
// - The RenderFrameHost receives a DidDropNavigation IPC.
//
// When the navigation encounters an error, the DidStartProvisionalLoad marking
// the start of the load of the error page will not be considered as marking a
// new navigation. It will not reset the NavigationHandleImpl in the
// RenderFrameHost.
//
// If the navigation needs a cross-site transfer, then the NavigationHandleImpl
// will briefly be held by the RenderFrameHostManager, until a suitable
// RenderFrameHost for the navigation has been found. The ownership of the
// NavigationHandleImpl will then be transferred to the new RenderFrameHost.
// The DidStartProvisionalLoad received by the new RenderFrameHost for the
// transferring navigation will not reset the NavigationHandleImpl, as it does
// not mark the start of a new navigation.
//
// PlzNavigate: the NavigationHandleImpl is created just after creating a new
// NavigationRequest. It is then owned by the NavigationRequest until the
// navigation is ready to commit. The NavigationHandleImpl ownership is then
// transferred to the RenderFrameHost in which the navigation will commit.
//
// When PlzNavigate is enabled, the NavigationHandleImpl will never be reset
// following the receipt of a DidStartProvisionalLoad IPC. There are also no
// transferring navigations. The other causes of NavigationHandleImpl reset in
// the RenderFrameHost still apply.
class CONTENT_EXPORT NavigationHandleImpl : public NavigationHandle {
public:
static scoped_ptr<NavigationHandleImpl> Create(const GURL& url,
const bool is_main_frame,
NavigatorDelegate* delegate);
~NavigationHandleImpl() override;
// NavigationHandle implementation:
const GURL& GetURL() const override;
net::Error GetNetErrorCode() const override;
bool IsInMainFrame() const override;
bool IsSamePage() override;
bool HasCommittedDocument() const override;
bool HasCommittedErrorPage() const override;
void set_net_error_code(net::Error net_error_code) {
net_error_code_ = net_error_code;
}
// Returns whether the navigation is currently being transferred from one
// RenderFrameHost to another. In particular, a DidStartProvisionalLoad IPC
// for the navigation URL, received in the new RenderFrameHost, should not
// indicate the start of a new navigation in that case.
bool is_transferring() const { return is_transferring_; }
void set_is_transferring(bool is_transferring) {
is_transferring_ = is_transferring;
}
// Called when the navigation was redirected. This will update the |url_| and
// inform the delegate.
void DidRedirectNavigation(const GURL& new_url);
// Called when the navigation was committed. This will update the |state_|
// and inform the delegate,
void DidCommitNavigation(bool same_page);
private:
// Used to track the state the navigation is currently in.
enum State {
DID_START = 0,
DID_COMMIT,
DID_COMMIT_ERROR_PAGE,
};
NavigationHandleImpl(const GURL& url,
const bool is_main_frame,
NavigatorDelegate* delegate);
// See NavigationHandle for a description of those member variables.
GURL url_;
net::Error net_error_code_;
State state_;
const bool is_main_frame_;
bool is_same_page_;
// Whether the navigation is in the middle of a transfer. Set to false when
// the DidStartProvisionalLoad is received from the new renderer.
bool is_transferring_;
// The delegate that should be notified about events related to this
// navigation.
NavigatorDelegate* delegate_;
DISALLOW_COPY_AND_ASSIGN(NavigationHandleImpl);
};
} // namespace content
#endif // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_
|
