olp-cpp-sdk  1.18.1
Public Member Functions | List of all members
olp::client::PendingRequests Class Referencefinal

A container for requests that have not finished yet. More...

#include <PendingRequests.h>

Public Member Functions

bool CancelAll ()
 Cancels all the pending tasks. More...
 
bool CancelAllAndWait ()
 Cancels all the pending tasks and waits for the tasks that are finalizing. More...
 
void Insert (TaskContext task_context)
 Inserts the task context into the request container. More...
 
void Remove (TaskContext task_context)
 Removes the task context. More...
 
size_t GetTaskCount () const
 Gets the number of tasks. More...
 

Detailed Description

A container for requests that have not finished yet.

Member Function Documentation

◆ CancelAll()

bool olp::client::PendingRequests::CancelAll ( )

Cancels all the pending tasks.

Note
This call does not wait for the tasks to finalize. To wait for the tasks to finalize, use CancelAllAndWait().
Returns
True on success; false otherwise.

◆ CancelAllAndWait()

bool olp::client::PendingRequests::CancelAllAndWait ( )

Cancels all the pending tasks and waits for the tasks that are finalizing.

Returns
True on success; false otherwise.

◆ GetTaskCount()

size_t olp::client::PendingRequests::GetTaskCount ( ) const

Gets the number of tasks.

Returns
The number of tasks pending.

◆ Insert()

void olp::client::PendingRequests::Insert ( TaskContext  task_context)

Inserts the task context into the request container.

Parameters
task_contextThe TaskContext instance.

◆ Remove()

void olp::client::PendingRequests::Remove ( TaskContext  task_context)

Removes the task context.

Parameters
task_contextThe TaskContext instance.

The documentation for this class was generated from the following file: