AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface

◆ GetPathWaitUntil()

bool drama::Path::GetPathWaitUntil ( std::chrono::steady_clock::time_point  until,
thread::TMessHandler action,
thread::TransEvtProcessor *const  eventProcessor = &_getPathEventProcessor 
)
inherited

Get a path to a the task.

If it is not running, load it if we have the details. Version with timeout.

This call initiates getting a path to the task. If the task is not running, it will be loaded if a sufficient information has been specified and the DRAMA Master task is running (or this task is allowed to load tasks itself)

This call must be made from a DRAMA Threaded action implementation, the address of the threaded action object must be passed. The thread will block until the operation is successful.

For a relative time, something like the following is needed. (ten second timeout).

   std::chrono::steady_clock::time_point until =  
      std::chrono::steady_clock::now() + std::chrono::seconds(10);
      GetPathWaitUntil(until,...);
*
Parameters
untilUntil when should we wait for this.
actionA pointer to the threaded action which is executing this operation.
eventProcessorAn object to use to process events. Defaults to a simple get path processor that causes the method to return the get path has completed. If this is successful and the program was loaded, a transaction will remain outstanding (until the program exits) but will have been orphaned.
Returns
Returns true if the transaction completed, false for a timeout.