Align CancellationToken to google style

Allow compiler to generate copy/move constructors and assignment operators.

Resolves: OLPEDGE-1130

Signed-off-by: Mykhailo Kuchma <[email protected]>

Author: mykhailo-kuchma

olp-cpp-sdk-core/include/olp/core/client/CancellationContext.inl

@@ -58,7 +58,7 @@ inline void CancellationContext::CancelOperation() {
     return;
   }
 
-  impl_->sub_operation_cancel_token_.cancel();
+  impl_->sub_operation_cancel_token_.Cancel();
   impl_->sub_operation_cancel_token_ = CancellationToken();
   impl_->is_cancelled_ = true;
 }

olp-cpp-sdk-core/include/olp/core/client/CancellationToken.h

@@ -22,6 +22,7 @@
 #include <functional>
 
 #include <olp/core/CoreApi.h>
+#include <olp/core/porting/deprecated.h>
 
 namespace olp {
 namespace client {
@@ -40,18 +41,18 @@ class CORE_API CancellationToken {
    * @param func an operation that should be used to cancel an authentication
    * request.
    */
-  CancellationToken(const std::function<void()> func);
+  CancellationToken(std::function<void()> func);
 
   /**
-   * @brief Copy Constructor
-   * @param other object to copy from
+   * @brief Cancels the current operation, calls the func_ instance variable.
    */
-  CancellationToken(const CancellationToken& other);
+  OLP_SDK_DEPRECATED("Deprecated, use Cancel instead.")
+  void cancel() const;
 
   /**
    * @brief Cancels the current operation, calls the func_ instance variable.
    */
-  void cancel() const;
+  void Cancel() const;
 
  private:
   std::function<void()> func_{};

olp-cpp-sdk-core/src/client/CancellationToken.cpp

@@ -21,13 +21,12 @@
 
 namespace olp {
 namespace client {
-CancellationToken::CancellationToken(const std::function<void()> func)
-  : func_(func) {}
+CancellationToken::CancellationToken(std::function<void()> func)
+    : func_(std::move(func)) {}
 
-CancellationToken::CancellationToken(const CancellationToken& other)
-  : func_(other.func_) {}
+void CancellationToken::cancel() const { Cancel(); }
 
-void CancellationToken::cancel() const {
+void CancellationToken::Cancel() const {
   if (func_) {
     func_();
   }

olp-cpp-sdk-core/src/client/PendingRequests.cpp

@@ -42,11 +42,11 @@ bool PendingRequests::CancelAll() {
   }
 
   for (auto& pair : requests_map) {
-    pair.second.cancel();
+    pair.second.Cancel();
   }
 
   for (auto context : contexts) {
-    context.CancelToken().cancel();
+    context.CancelToken().Cancel();
   }
 
   return true;

olp-cpp-sdk-core/tests/client/TaskContextTest.cpp

@@ -206,7 +206,7 @@ TEST(TaskContextTest, CancelToken) {
 
   EXPECT_TRUE(execution_started.Wait());
 
-  context.CancelToken().cancel();
+  context.CancelToken().Cancel();
 
   continue_execution.Notify();
 

olp-cpp-sdk-core/tests/olpclient/OlpClientTest.cpp

@@ -934,7 +934,7 @@ TEST_F(OlpClientTest, CancelBeforeResponse) {
                                       std::multimap<std::string, std::string>(),
                                       nullptr, std::string(), callback);
 
-  cancel_token.cancel();
+  cancel_token.Cancel();
   wait_for_cancel->set_value(true);
   ASSERT_TRUE(was_cancelled->load());
   ASSERT_EQ(std::future_status::ready,
@@ -976,7 +976,7 @@ TEST_F(OlpClientTest, CancelAfterCompletion) {
                                       nullptr, std::string(), callback);
 
   auto response = promise.get_future().get();
-  cancel_token.cancel();
+  cancel_token.Cancel();
 
   ASSERT_TRUE(was_cancelled->load());
 }
@@ -1021,11 +1021,11 @@ TEST_F(OlpClientTest, CancelDuplicate) {
                                       std::multimap<std::string, std::string>(),
                                       nullptr, std::string(), callback);
 
-  cancel_token.cancel();
-  cancel_token.cancel();
-  cancel_token.cancel();
+  cancel_token.Cancel();
+  cancel_token.Cancel();
+  cancel_token.Cancel();
   wait_for_cancel->set_value(true);
-  cancel_token.cancel();
+  cancel_token.Cancel();
 
   ASSERT_TRUE(was_cancelled->load());
   ASSERT_EQ(std::future_status::ready,
@@ -1083,7 +1083,7 @@ TEST_F(OlpClientTest, CancelRetry) {
                                       nullptr, std::string(), callback);
 
   wait_for_cancel->get_future().get();
-  cancel_token.cancel();
+  cancel_token.Cancel();
 
   EXPECT_EQ(std::future_status::ready,
             promise.get_future().wait_for(std::chrono::seconds(2)));

olp-cpp-sdk-dataservice-read/src/ApiClientLookup.cpp

@@ -186,7 +186,7 @@ ApiClientLookup::ApiClientResponse ApiClientLookup::LookupApi(
 
         return client::CancellationToken([&, token, flag]() {
           if (flag->exchange(false)) {
-            token.cancel();
+            token.Cancel();
             condition.Notify();
           }
         });

olp-cpp-sdk-dataservice-read/src/Common.h

@@ -52,8 +52,8 @@ inline client::CancellationToken ScheduleFetch(TaskScheduler&& schedule_task,
         std::move(request.WithFetchOption(FetchOptions::OnlineOnly)), nullptr);
 
     return client::CancellationToken([=]() {
-      cache_token.cancel();
-      online_token.cancel();
+      cache_token.Cancel();
+      online_token.Cancel();
     });
   }
 

olp-cpp-sdk-dataservice-read/src/MultiRequestContext.h

@@ -65,7 +65,7 @@ class MultiRequestContext final {
       OLP_SDK_LOG_INFO_F(kMultiRequestContextLogTag,
                          "~MultiRequestContext() -> cancelling id %s",
                          itr->first.c_str());
-      itr->second->cancellation_token_.cancel();
+      itr->second->cancellation_token_.Cancel();
     }
   }
 
@@ -199,7 +199,7 @@ class MultiRequestContext final {
           // this is the last callback.
           // cancel the underlying request, allowing the provider to invoke the
           // callback(s)
-          context->cancellation_token_.cancel();
+          context->cancellation_token_.Cancel();
         }
 
         auto req = *requestItr;

olp-cpp-sdk-dataservice-read/src/repositories/CatalogRepository.cpp

@@ -208,7 +208,7 @@ read::CatalogResponse CatalogRepository::GetCatalog(
 
         return CancellationToken([&, interest_flag, token]() {
           if (interest_flag->exchange(false)) {
-            token.cancel();
+            token.Cancel();
             condition.Notify();
           }
         });
@@ -384,7 +384,7 @@ MetadataApi::CatalogVersionResponse CatalogRepository::GetLatestVersion(
 
         return client::CancellationToken([&, interest_flag, token]() {
           if (interest_flag->exchange(false)) {
-            token.cancel();
+            token.Cancel();
             condition.Notify();
           }
         });