aboutsummaryrefslogtreecommitdiff
path: root/fcp/client/http/curl/curl_api.h
blob: cebb6cfddb46fa14422960da2898d7228bfcf1d3 (plain)
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
/*
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef FCP_CLIENT_HTTP_CURL_CURL_API_H_
#define FCP_CLIENT_HTTP_CURL_CURL_API_H_

#include <memory>
#include <string>
#include <type_traits>

#include "absl/synchronization/mutex.h"
#include "curl/curl.h"

namespace fcp::client::http::curl {
// An RAII wrapper around the libcurl easy handle, which works with one request.
// The class is not thread-safe.
class CurlEasyHandle {
 public:
  ~CurlEasyHandle();
  CurlEasyHandle(const CurlEasyHandle&) = delete;
  CurlEasyHandle& operator=(const CurlEasyHandle&) = delete;

  CURLcode GetInfo(CURLINFO info, curl_off_t* value) const;

  template <typename T, typename = std::enable_if_t<std::is_trivial_v<T>>>
  CURLcode SetOpt(CURLoption option, T value) {
    return curl_easy_setopt(easy_handle_, option, value);
  }
  CURLcode SetOpt(CURLoption option, const std::string& value) {
    return SetOpt(option, value.c_str());
  }

  // Converts the curl code into a human-readable form.
  ABSL_MUST_USE_RESULT static std::string StrError(CURLcode code);

  // Returns the underlying curl handle.
  ABSL_MUST_USE_RESULT CURL* GetEasyHandle() const;

 private:
  friend class CurlApi;
  CurlEasyHandle();
  CURL* const easy_handle_;
};

// An RAII wrapper around the libcurl multi handle, which is a bundle of easy
// requests that performs them in parallel in one thread. The class is not
// thread-safe.
class CurlMultiHandle {
 public:
  ~CurlMultiHandle();
  CurlMultiHandle(const CurlMultiHandle&) = delete;
  CurlMultiHandle& operator=(const CurlMultiHandle&) = delete;

  // Fetches the next message in the message queue.
  CURLMsg* InfoRead(int* msgs_in_queue);

  // Add a new request to the bundle.
  CURLMcode AddEasyHandle(CurlEasyHandle* easy_handle);

  // Remove the requests from the bundle. It will cancel an unfinished request,
  // but it will not delete the easy handle.
  CURLMcode RemoveEasyHandle(CurlEasyHandle* easy_handle);

  // Performs all active tasks and returns.
  CURLMcode Perform(int* num_running_handles);

  // Waits for a new job
  CURLMcode Poll(curl_waitfd extra_fds[], unsigned int extra_nfds,
                 int timeout_ms, int* numfds);

  // Converts the curl code into a human-readable form.
  ABSL_MUST_USE_RESULT static std::string StrError(CURLMcode code);

 private:
  friend class CurlApi;
  CurlMultiHandle();
  CURLM* const multi_handle_;
};

// An RAII wrapper around global initialization for libcurl. It forces the user
// to create it first, so the initialization can be made, on which handles
// depend. The class needs to be created only once, and its methods are
// thread-safe.
class CurlApi {
 public:
  CurlApi();
  ~CurlApi();
  CurlApi(const CurlApi&) = delete;
  CurlApi& operator=(const CurlApi&) = delete;

  ABSL_MUST_USE_RESULT std::unique_ptr<CurlEasyHandle> CreateEasyHandle() const;
  ABSL_MUST_USE_RESULT std::unique_ptr<CurlMultiHandle> CreateMultiHandle()
      const;

 private:
  mutable absl::Mutex mutex_;
};

}  // namespace fcp::client::http::curl

#endif  // FCP_CLIENT_HTTP_CURL_CURL_API_H_