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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_SYNC_ENGINE_NET_HTTP_POST_PROVIDER_H_
#define COMPONENTS_SYNC_ENGINE_NET_HTTP_POST_PROVIDER_H_
#include <string>
#include "base/memory/ref_counted.h"
#include "url/gurl.h"
namespace syncer {
// An interface the embedding application (e.g. Chromium) implements to provide
// required HTTP POST functionality to the syncer backend. This interface is
// designed for one-time use. You create one, use it, and create another if you
// want to make a subsequent POST.
// It is RefCountedThreadSafe because its implementations may PostTask to
// background task runners, and thus need to stick around across context
// switches, etc.
class HttpPostProvider : public base::RefCountedThreadSafe<HttpPostProvider> {
public:
// Add additional headers to the request.
virtual void SetExtraRequestHeaders(const char* headers) = 0;
// Set the URL to POST to.
virtual void SetURL(const GURL& url) = 0;
// Set the type, length and content of the POST payload.
// `content_type` is a null-terminated MIME type specifier.
// `content` is a data buffer; Do not interpret as a null-terminated string.
// `content_length` is the total number of chars in `content`. It is used to
// assign/copy `content` data.
virtual void SetPostPayload(const char* content_type,
int content_length,
const char* content) = 0;
// Returns true if the URL request succeeded. If the request failed,
// error() may be non-zero and hence contain more information.
virtual bool MakeSynchronousPost(int* net_error_code,
int* http_status_code) = 0;
// Get the length of the content returned in the HTTP response.
// This does not count the trailing null-terminating character returned
// by GetResponseContent, so it is analogous to calling string.length.
virtual int GetResponseContentLength() const = 0;
// Get the content returned in the HTTP response.
// This is a null terminated string of characters.
// Value should be copied.
virtual const char* GetResponseContent() const = 0;
// Get the value of a header returned in the HTTP response.
// If the header is not present, returns the empty string.
virtual const std::string GetResponseHeaderValue(
const std::string& name) const = 0;
// Abandon any pending POST and unblock caller in MakeSynchronousPost.
// This must be safe to call from any thread.
virtual void Abort() = 0;
protected:
friend class base::RefCountedThreadSafe<HttpPostProvider>;
virtual ~HttpPostProvider() = default;
};
} // namespace syncer
#endif // COMPONENTS_SYNC_ENGINE_NET_HTTP_POST_PROVIDER_H_
|
