RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | List of all members
rstudio::launcher_plugins::system::AsyncDeadlineEvent Class Referencefinal

Class which may be used to post async work to be performed at a later time. More...

#include <Asio.hpp>

Public Member Functions

 AsyncDeadlineEvent (const AsioFunction &in_work, const DateTime &in_deadlineTime)
 Constructor. More...
 
 AsyncDeadlineEvent (const AsioFunction &in_work, const TimeDuration &in_waitTime)
 Constructor. More...
 
 ~AsyncDeadlineEvent ()
 Destructor. The event will be canceled if this invoked before the deadline time.
 
void cancel ()
 Cancels the event, if invoked before the deadline time.
 
void start ()
 Starts waiting for the event.
 

Detailed Description

Class which may be used to post async work to be performed at a later time.

Constructor & Destructor Documentation

◆ AsyncDeadlineEvent() [1/2]

rstudio::launcher_plugins::system::AsyncDeadlineEvent::AsyncDeadlineEvent ( const AsioFunction &  in_work,
const DateTime in_deadlineTime 
)

Constructor.

Parameters
in_workThe work to be performed when the deadline time is reached.
in_deadlineTimeThe time at which the work should be performed.

◆ AsyncDeadlineEvent() [2/2]

rstudio::launcher_plugins::system::AsyncDeadlineEvent::AsyncDeadlineEvent ( const AsioFunction &  in_work,
const TimeDuration in_waitTime 
)

Constructor.

Parameters
in_workThe work to be performed when the deadline time is reached.
in_waitTimeThe amount of time, from the invocation time, that should pass before the work is performed.

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