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
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef REMOTING_BASE_PROTOBUF_HTTP_REQUEST_BASE_H_
#define REMOTING_BASE_PROTOBUF_HTTP_REQUEST_BASE_H_
#include <memory>
#include <string>
#include "base/dcheck_is_on.h"
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "remoting/base/http_status.h"
#include "remoting/base/scoped_protobuf_http_request.h"
namespace network {
namespace mojom {
class URLLoaderFactory;
} // namespace mojom
class SimpleURLLoader;
} // namespace network
namespace remoting {
class ProtobufHttpClient;
struct ProtobufHttpRequestConfig;
// Base request class for unary and server streaming requests.
class ProtobufHttpRequestBase {
public:
explicit ProtobufHttpRequestBase(
std::unique_ptr<ProtobufHttpRequestConfig> config);
virtual ~ProtobufHttpRequestBase();
// Creates an ScopedProtobufHttpRequest instance that will cancel the
// request once the instance is deleted. It will be no-op if the request is
// not in the client's pending request list.
std::unique_ptr<ScopedProtobufHttpRequest> CreateScopedRequest();
const ProtobufHttpRequestConfig& config() const { return *config_; }
protected:
// Called when the protobuf HTTP client failed to get the access token. Note
// that the subclass implementation should not invoke |invalidator_| since the
// request has never been started.
virtual void OnAuthFailed(const HttpStatus& status) = 0;
// Called to start a request, and whenever the request is retried.
virtual void StartRequestInternal(
network::mojom::URLLoaderFactory* loader_factory) = 0;
// Returns a deadline for when the request has to be finished. Returns zero
// if the request doesn't timeout. This is generally only useful for unary
// requests.
virtual base::TimeDelta GetRequestTimeoutDuration() const = 0;
// Returns the http status from |url_loader_|. Only useful when |url_loader_|
// informs that the request has been completed.
HttpStatus GetUrlLoaderStatus() const;
// Subclasses should call this method whenever a request fails.
// Returns true if the failure has been handled, in which case do not handle
// the response, and expect StartRequestInternal() to be called.
// If this method returns true, the subclass should handle the response.
bool HandleRetry(HttpStatus::Code code);
std::unique_ptr<network::SimpleURLLoader> url_loader_;
// Subclass should run this closure whenever its lifetime ends, e.g. response
// is received or stream is closed. This will delete |this| from the parent
// ProtobufHttpClient.
base::OnceClosure invalidator_;
private:
friend class ProtobufHttpClient;
using CreateUrlLoader =
base::RepeatingCallback<std::unique_ptr<network::SimpleURLLoader>(
const ProtobufHttpRequestConfig&)>;
struct RetryEntry;
// Called by ProtobufHttpClient.
void StartRequest(network::mojom::URLLoaderFactory* loader_factory,
CreateUrlLoader create_url_loader,
base::OnceClosure invalidator);
void DoRequest();
void Invalidate();
void ResetRequestDeadline();
std::unique_ptr<const ProtobufHttpRequestConfig> config_;
// These are only set after StartRequest() is called.
CreateUrlLoader create_url_loader_;
raw_ptr<network::mojom::URLLoaderFactory> loader_factory_;
// Non-null iff StartRequest() is called and `config_.retry_policy` is
// configured.
// `retry_entry_` must be deleted before `config_` since it holds a raw_ptr to
// `config_`.
std::unique_ptr<RetryEntry> retry_entry_;
#if DCHECK_IS_ON()
base::TimeTicks request_deadline_;
#endif // DCHECK_IS_ON()
base::WeakPtrFactory<ProtobufHttpRequestBase> weak_factory_{this};
};
} // namespace remoting
#endif // REMOTING_BASE_PROTOBUF_HTTP_REQUEST_BASE_H_
|
