olp-cpp-sdk  1.21.0
CancellationToken.h
1 /*
2  * Copyright (C) 2019-2021 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 <functional>
23 
24 #include <olp/core/CoreApi.h>
25 #include <olp/core/porting/deprecated.h>
26 
27 namespace olp {
28 namespace client {
29 
33 class CORE_API CancellationToken {
34  public:
36  using CancelFuncType = std::function<void()>;
37 
38  CancellationToken() = default;
39 
47 
51  void Cancel() const;
52 
53  private:
54  CancelFuncType func_;
55 };
56 
57 } // namespace client
58 } // namespace olp
Cancels service requests.
Definition: CancellationToken.h:33
std::function< void()> CancelFuncType
An alias for the cancellation function.
Definition: CancellationToken.h:36
void Cancel() const
Cancels the current operation and calls the func_ instance.
CancellationToken(CancelFuncType func)
Creates the CancellationToken instance.
Rules all the other namespaces.
Definition: AppleSignInProperties.h:24