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

A helper class that allows one thread to call and wait for a notification in the other thread. More...

#include <Condition.h>

Public Member Functions

void Notify ()
 Called by the task callback to notify Wait to unblock the routine.
 
bool Wait (std::chrono::milliseconds timeout=std::chrono::seconds(60))
 Waits for the Notify function. More...
 

Detailed Description

A helper class that allows one thread to call and wait for a notification in the other thread.

Member Function Documentation

◆ Wait()

bool olp::client::Condition::Wait ( std::chrono::milliseconds  timeout = std::chrono::seconds(60))
inline

Waits for the Notify function.

Parameters
timeoutThe time (in milliseconds) during which the Wait function waits for the notification.
Returns
True if the notification is returned before the timeout; false otherwise.

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