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
|
// 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_CLIENT_H_
#define REMOTING_BASE_PROTOBUF_HTTP_CLIENT_H_
#include <list>
#include <memory>
#include <optional>
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "remoting/base/oauth_token_getter.h"
#include "remoting/base/url_loader_network_service_observer.h"
namespace net {
class ClientCertStore;
} // namespace net
namespace network {
class SharedURLLoaderFactory;
class SimpleURLLoader;
} // namespace network
namespace remoting {
class ProtobufHttpRequestBase;
struct ProtobufHttpRequestConfig;
// Helper class for executing REST/Protobuf requests over HTTP.
class ProtobufHttpClient final {
public:
// |server_endpoint|: the hostname of the server.
// |token_getter|: nullable if none of the requests are authenticated. Must
// outlive |this|.
// |client_cert_store|: nullable if none of the requests have
// provide_certificate set to true.
ProtobufHttpClient(
const std::string& server_endpoint,
OAuthTokenGetter* token_getter,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
std::unique_ptr<net::ClientCertStore> client_cert_store = nullptr);
~ProtobufHttpClient();
ProtobufHttpClient(const ProtobufHttpClient&) = delete;
ProtobufHttpClient& operator=(const ProtobufHttpClient&) = delete;
// Executes a unary request. Caller will not be notified of the result if
// CancelPendingRequests() is called or |this| is destroyed.
void ExecuteRequest(std::unique_ptr<ProtobufHttpRequestBase> request);
// Cancel all pending requests.
void CancelPendingRequests();
// Indicates whether the client has any pending requests.
bool HasPendingRequests() const;
private:
using PendingRequestList =
std::list<std::unique_ptr<ProtobufHttpRequestBase>>;
// std::list iterators are stable, so they survive list editing and only
// become invalidated when underlying element is deleted.
using PendingRequestListIterator = PendingRequestList::iterator;
void DoExecuteRequest(std::unique_ptr<ProtobufHttpRequestBase> request,
OAuthTokenGetter::Status status,
const OAuthTokenInfo& token_info);
std::unique_ptr<network::SimpleURLLoader> CreateSimpleUrlLoader(
const std::string& access_token,
base::TimeDelta timeout_duration,
const ProtobufHttpRequestConfig& config);
void CancelRequest(const PendingRequestListIterator& request_iterator);
std::string server_endpoint_;
raw_ptr<OAuthTokenGetter> token_getter_;
std::optional<UrlLoaderNetworkServiceObserver> service_observer_;
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory_;
std::unique_ptr<net::ClientCertStore> client_cert_store_;
PendingRequestList pending_requests_;
SEQUENCE_CHECKER(sequence_checker_);
base::WeakPtrFactory<ProtobufHttpClient> weak_factory_{this};
};
} // namespace remoting
#endif // REMOTING_BASE_PROTOBUF_HTTP_CLIENT_H_
|