olp-cpp-sdk  1.18.1
HttpResponse.h
1 /*
2  * Copyright (C) 2019-2022 HERE Europe B.V.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  * SPDX-License-Identifier: Apache-2.0
17  * License-Filename: LICENSE
18  */
19 
20 #pragma once
21 
22 #include <sstream>
23 #include <string>
24 #include <utility>
25 #include <vector>
26 
27 #include <olp/core/CoreApi.h>
28 #include <olp/core/http/NetworkTypes.h>
29 
30 namespace olp {
31 namespace client {
32 
38  public:
39  NetworkStatistics() = default;
40 
49  NetworkStatistics(uint64_t bytes_uploaded, uint64_t bytes_downloaded)
50  : bytes_uploaded_{bytes_uploaded}, bytes_downloaded_{bytes_downloaded} {}
51 
57  uint64_t GetBytesUploaded() const { return bytes_uploaded_; }
58 
64  uint64_t GetBytesDownloaded() const { return bytes_downloaded_; }
65 
68  bytes_uploaded_ += other.bytes_uploaded_;
69  bytes_downloaded_ += other.bytes_downloaded_;
70  return *this;
71  }
72 
75  NetworkStatistics statistics(*this);
76  statistics += other;
77  return statistics;
78  }
79 
80  private:
81  uint64_t bytes_uploaded_{0};
82  uint64_t bytes_downloaded_{0};
83 };
84 
89 class CORE_API HttpResponse {
90  public:
91  HttpResponse() = default;
92  virtual ~HttpResponse() = default;
93 
100  HttpResponse(int status, std::string response = {}) // NOLINT
101  : status(status), response(std::move(response)) {}
102 
110  HttpResponse(int status, std::stringstream&& response)
111  : status(status), response(std::move(response)) {}
112 
121  HttpResponse(int status, std::stringstream&& response, http::Headers headers)
122  : status(status),
123  response(std::move(response)),
124  headers(std::move(headers)) {}
125 
135  : status(other.status), headers(other.headers) {
136  response << other.response.rdbuf();
137  if (!response.good()) {
138  // Depending on the users handling of the stringstream it might be that
139  // the read position is already at the end and thus operator<< cannot
140  // read anything, so lets try with the safer but more memory intensive
141  // solution as a second step.
142  response.str(other.response.str());
143  }
144  }
145 
155  if (this != &other) {
156  status = other.status;
157  response = std::stringstream{};
158  response << other.response.rdbuf();
159  headers = other.headers;
160  }
161 
162  return *this;
163  }
164 
167 
170 
176  void GetResponse(std::vector<unsigned char>& output) {
177  response.seekg(0, std::ios::end);
178  const auto pos = response.tellg();
179  if (pos > 0) {
180  output.resize(pos);
181  }
182  response.seekg(0, std::ios::beg);
183  response.read(reinterpret_cast<char*>(output.data()), output.size());
184  response.seekg(0, std::ios::beg);
185  }
186 
192  void GetResponse(std::string& output) const { output = response.str(); }
193 
199  const http::Headers& GetHeaders() const { return headers; }
200 
209  int GetStatus() const { return status; }
210 
216  void SetNetworkStatistics(NetworkStatistics network_statistics) {
217  network_statistics_ = network_statistics;
218  }
219 
226  return network_statistics_;
227  }
228 
233  int status{static_cast<int>(olp::http::ErrorCode::UNKNOWN_ERROR)};
237  std::stringstream response;
242 
243  private:
244  NetworkStatistics network_statistics_;
245 };
246 
247 } // namespace client
248 } // namespace olp
This class represents the HTTP response created from the NetworkResponse and the request body.
Definition: HttpResponse.h:89
HttpResponse(int status, std::stringstream &&response, http::Headers headers)
Creates the HttpResponse instance.
Definition: HttpResponse.h:121
HttpResponse(int status, std::string response={})
Creates the HttpResponse instance.
Definition: HttpResponse.h:100
std::stringstream response
Definition: HttpResponse.h:237
const NetworkStatistics & GetNetworkStatistics() const
Get the NetworkStatistics.
Definition: HttpResponse.h:225
HttpResponse(int status, std::stringstream &&response)
Creates the HttpResponse instance.
Definition: HttpResponse.h:110
HttpResponse(const HttpResponse &other)
A copy constructor.
Definition: HttpResponse.h:134
int GetStatus() const
Return the response status.
Definition: HttpResponse.h:209
void GetResponse(std::string &output) const
Copy HttpResponse content to a string.
Definition: HttpResponse.h:192
HttpResponse & operator=(HttpResponse &&)=default
A default move assignment operator.
void GetResponse(std::vector< unsigned char > &output)
Copy HttpResponse content to a vector of unsigned chars.
Definition: HttpResponse.h:176
HttpResponse & operator=(const HttpResponse &other)
A copy assignment operator.
Definition: HttpResponse.h:154
http::Headers headers
Definition: HttpResponse.h:241
const http::Headers & GetHeaders() const
Return the const reference to the response headers.
Definition: HttpResponse.h:199
int status
Definition: HttpResponse.h:233
void SetNetworkStatistics(NetworkStatistics network_statistics)
Set NetworkStatistics.
Definition: HttpResponse.h:216
HttpResponse(HttpResponse &&)=default
A default move constructor.
Network statistics with information on the outbound and inbound trafic during API calls.
Definition: HttpResponse.h:37
NetworkStatistics & operator+=(const NetworkStatistics &other)
An overloaded addition operator for accumulating statistics.
Definition: HttpResponse.h:67
NetworkStatistics(uint64_t bytes_uploaded, uint64_t bytes_downloaded)
Creates the NetworkStatistics instance.
Definition: HttpResponse.h:49
NetworkStatistics operator+(const NetworkStatistics &other) const
An overloaded addition operator for accumulating statistics.
Definition: HttpResponse.h:74
uint64_t GetBytesUploaded() const
Get the number of bytes of outbound traffic.
Definition: HttpResponse.h:57
uint64_t GetBytesDownloaded() const
Get the number of bytes of inbound traffic.
Definition: HttpResponse.h:64
@ UNKNOWN_ERROR
Internal error that can't be interpreted.
std::vector< Header > Headers
An alias for a vector of the HTTP headers.
Definition: NetworkTypes.h:140
Rules all the other namespaces.
Definition: AppleSignInProperties.h:24