Class CancellationToken
Defined in File CancellationToken.h
Class Documentation
-
class CancellationToken
Used with Http requests to managed cancellation states atomically.
Allows a request to be cancelled within the web client if connection is shutdown.
Public Functions
-
CancellationToken()
Constructs a CancellationToken.
-
CancellationToken(const CancellationToken &rhs) = delete
Copy constructor.
- Parameters
rhs – const CancellationToken&
-
CancellationToken(CancellationToken &&rhs) = delete
Move constructor.
- Parameters
rhs – CancellationToken&&
-
~CancellationToken()
Destructor.
-
CancellationToken &operator=(const CancellationToken &rhs) = delete
Copy assignment.
- Parameters
rhs – const CancellationToken&
- Returns
-
CancellationToken &operator=(CancellationToken &&rhs) = delete
Move assignment.
- Parameters
rhs – CancellationToken&&
- Returns
-
void Cancel()
Sets the cancellation state to cancelled.
-
bool Cancelled() const
Check if a request has been cancelled.
- Returns
bool
Public Static Functions
-
static CancellationToken &Dummy()
Constructs a blank token.
- Returns
-
CancellationToken()