Class which stores options specific to the Local Container system. More...
#include <LocalOptions.hpp>
Inheritance diagram for rstudio::launcher_plugins::local::LocalOptions:
Public Member Functions | |
| size_t | getNodeConnectionTimeoutSeconds () const |
| Gets the number of seconds that can elapse before an attempted connection to another local node will be timed out. More... | |
| const system::FilePath & | getSecureCookieKeyFile () const |
| Gets the secure cookie key file to use for decrypting PAM passwords. More... | |
| void | initialize () |
| Method which initializes LocalOptions. This method should be called exactly once, before the options file is read. More... | |
| bool | shouldSaveUnspecifiedOutput () const |
| Gets whether to save output for a job when the output path has not been specified. More... | |
 Public Member Functions inherited from rstudio::launcher_plugins::Noncopyable | |
| Noncopyable ()=default | |
| Default constructor. | |
| Noncopyable (const Noncopyable &)=delete | |
| Deleted copy constructor. | |
| Noncopyable & | operator= (const Noncopyable &)=delete |
| Deleted assignment operator. | |
Static Public Member Functions | |
| static LocalOptions & | getInstance () |
| Gets the single instance of LocalOptions for the plugin. More... | |
Detailed Description
Class which stores options specific to the Local Container system.
Member Function Documentation
◆ getInstance()
|
static |
Gets the single instance of LocalOptions for the plugin.
- Returns
- The single instance of LocalOptions for the plugin.
◆ getNodeConnectionTimeoutSeconds()
| size_t rstudio::launcher_plugins::local::LocalOptions::getNodeConnectionTimeoutSeconds | ( | ) | const |
Gets the number of seconds that can elapse before an attempted connection to another local node will be timed out.
- Returns
- The timeout for connecting to other local nodes, in seconds.
◆ getSecureCookieKeyFile()
| const system::FilePath& rstudio::launcher_plugins::local::LocalOptions::getSecureCookieKeyFile | ( | ) | const |
Gets the secure cookie key file to use for decrypting PAM passwords.
- Returns
- The secure cookie key file to use for decrypting PAM passwords.
◆ initialize()
| void rstudio::launcher_plugins::local::LocalOptions::initialize | ( | ) |
Method which initializes LocalOptions. This method should be called exactly once, before the options file is read.
This is where Local Options are registered with the Options object.
◆ shouldSaveUnspecifiedOutput()
| bool rstudio::launcher_plugins::local::LocalOptions::shouldSaveUnspecifiedOutput | ( | ) | const |
Gets whether to save output for a job when the output path has not been specified.
- Returns
- True if job output should be saved when no output path was specified; false otherwise.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/workspace/IDE/launcher-plugin-sdk/master/plugins/Local/include/LocalOptions.hpp
