|
RStudio Launcher Plugin SDK
1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
|
| ▼Nrstudio | |
| ▼Nlauncher_plugins | |
| ►Napi | |
| CAbstractMultiStream | Manages the sending of streamed responses |
| CAbstractOutputStream | Streams job output data to the launcher |
| CAbstractPluginApi | Base class for the Launcher Plugin API |
| CAbstractResourceStream | Streams job resource utilization data to the Launcher |
| CAbstractTimedResourceStream | |
| CAzureFileMountSource | Represents an Azure File Mount Source |
| CBootstrapRequest | Represents a bootstrap request received from the Launcher |
| CBootstrapResponse | Class which represents a bootstrap response which can be sent to the Launcher in response to a bootstrap request |
| CCephFsMountSource | Represents a Ceph File System Mount Source |
| CClusterInfoResponse | Class which represents a cluster info response which should be sent to the Launcher in response to a cluster info request |
| CContainer | Struct which represents the container to use when launching a containerized job |
| CContainerConfiguration | Describes the container configuration of the Job Source |
| CControlJobRequest | Request from the launcher to control the state of a Job |
| CControlJobResponse | Class which represents the result of a control job operation |
| CErrorResponse | Class which represents an error response which can be sent to the Launcher in response to any request |
| CExposedPort | Struct which represents an exposed port on a containerized job |
| CFileOutputStream | Streams job output data from a file |
| CGlusterFsMountSource | |
| CHeartbeatResponse | Class which represents a heartbeat response which should be sent to the Launcher every configured heartbeat-interval-seconds |
| CHostMountSource | Represents a path to mount on the same host as the Job |
| CIJobSource | Generic interface for communicating with a Job Source. Implementation is plugin specific |
| CJob | Structure which represents a job |
| CJobConfig | Struct which represents a custom configuration setting for jobs launched with a given Plugin |
| CJobIdRequest | Base class which should be used for requests that require a Job ID |
| CJobLock | RAII class for locking access to a Job object. Should be used every time a Job is modified |
| CJobSourceConfiguration | Describes the capabilities and configuration of this Job Source |
| CJobStateRequest | Represents a job state request received from the Launcher |
| CJobStateResponse | Class which represents a job state response which can be sent to the Launcher in response to a get or submit job request |
| CJobStatusRequest | Request from the launcher to begin or end a Job Status Stream |
| CJobStatusResponse | Class which represents a Job Status Stream, either for all jobs or for a specific job |
| CMount | Struct which represents an file system mount available to a job |
| CMountSource | Struct which represents the source path of an NFS Mount |
| CMultiStreamResponse | Base class for responses which are returned to multiple stream requests |
| CNetworkInfo | Represents the network information for a job |
| CNetworkRequest | Request from the Launcher to get the network information for a job |
| CNetworkResponse | Class which represents a network information response which should be sent to the Launcher in response to a Job network information request |
| CNfsMountSource | Represents an NFS Mount Source |
| COutputStreamRequest | Request from the launcher to begin or end a Job Output Stream |
| COutputStreamResponse | Class which represents a Job Output Stream response for a specific job |
| CPlacementConstraint | Struct which represents a custom placement constraint for the job |
| CRequest | Base class for all requests which may be received from the Launcher |
| ►CResourceLimit | Struct which represents a resource limit for a job |
| CType | |
| CResourceUtilData | Represents the current resource utilization of a job |
| CResourceUtilStreamRequest | Request from the launcher to begin or end a Resource Utilization Stream |
| CResourceUtilStreamResponse | Class which represents a Resource Utilization Stream response for a specific job |
| CResponse | Represents the common components of all responses which can be sent the RStudio Launcher |
| CStreamSequenceId | An identifier for a MultiStreamResponse |
| CSubmitJobRequest | Represents a submit job request from the Launcher |
| CUserRequest | Base class which should be used by the class of requests which require a username |
| ►Ncomms | |
| CAbstractLauncherCommunicator | Base class responsible for communicating the the launcher. The type of communication is implementation dependent |
| ►Njobs | |
| CAbstractJobRepository | Stores any jobs currently in the job scheduling system |
| CAbstractJobStatusWatcher | Manages posting job status updates to the notifier |
| CAbstractTimedJobStatusWatcher | Responsible for polling job statuses on a timer |
| CJobStatusNotifier | Class which notifies subscribers when a job updates |
| ►Njson | |
| ►Ndetail | |
| Cis_json_type | Struct which is either a child class of std::true_type or std::false_type depending on whether T is a JSON type (e.g. Value, Object, Array) or not (e.g. int, bool, string, float, etc.) |
| ►CArray | Class which represents a JSON array |
| CIterator | Class which allows iterating over the elements of a JSON array |
| ►CObject | Class which represents a specific type of JSON Value: a JSON object |
| CIterator | Class which allows iterating over the members of a JSON object |
| CMember | Class which represents a single member of a JSON object |
| CValue | Class which represents a json value |
| ►Nlocal | |
| CLocalJobRepository | Responsible for job persistence |
| CLocalJobRunner | Runs jobs on the local machine |
| CLocalJobSource | Class which is responsible for running and retrieving information about jobs on the Local system |
| CLocalOptions | Class which stores options specific to the Local Container system |
| CLocalPluginApi | Launcher Plugin API for the Local Plugin |
| CLocalResourceStream | |
| CLocalSecureCookie | Reads and makes available the secure-cookie-key-file specified in the launcher.local.conf file |
| ►Nlogging | |
| CFileLogDestination | Class which allows sending log messages to a file |
| CFileLogOptions | Class which represents the options for a file logger |
| CILogDestination | Interface which allows a logger to write a log message to a destination |
| CRefreshParams | A struct encapsulating various params to pass when refreshing log destinations. This carries data that some loggers may be interested in consuming to determine how the refresh should be carried out. See the FileLogDestination for a concrete example of this |
| ►Noptions | |
| CAbstractUserProfiles | Base class which reads an ini-based user profiles file |
| ►COptions | Options for the plugin |
| CInit | Class for initializing Options |
| CValue | Concrete class which represents an option Value |
| ►Nquickstart | |
| CQuickStartJobRepository | |
| CQuickStartJobSource | Class which is responsible for running and retrieving information about jobs in the job scheduling system |
| CQuickStartJobStatusWatcher | |
| CQuickStartOptions | Class which defines options for the QuickStart Launcher Plugin |
| CQuickStartPluginApi | Launcher Plugin API for the QuickStart Plugin |
| CQuickStartResourceStream | |
| ►Nsystem | |
| ►Nposix | |
| CIpAddress | Represents an IP address |
| ►Nprocess | |
| CAbstractChildProcess | Base class for a child process, which will be launched via rsandbox |
| CAsyncProcessCallbacks | Callbacks that will be invoked when certain events happen in the asynchronous child process |
| CProcessInfo | Represents the details of a process that is running on this machine |
| CProcessOptions | Defines a process that can be run |
| CProcessResult | Represents the result of a synchronous child process |
| CProcessSupervisor | Creates and manages non-blocking child processes |
| CSyncChildProcess | A blocking child process |
| CAsioService | Async input/output class which may be used to manage ASIO operations |
| CAsioStream | Class which allows reading from or writing to streams asynchronously |
| CAsyncDeadlineEvent | Class which may be used to post async work to be performed at a later time |
| CAsyncTimedEvent | Class which performs an action asynchronously every specified number of seconds |
| CDateTime | Class which represents a date and time in UTC |
| CFilePath | Class which represents a path on the system. May be any type of file (e.g. directory, symlink, regular file, etc.) |
| CPathScopeImplDeleter | Struct which implements the deleter for PathScopeImpl |
| CRemoveOnExitScope | RAII class for restoring the current working directory |
| CRestoreCurrentPathScope | RAII class for restoring the current working directory |
| CTimeDuration | Represents an duration of time (e.g. 5 hours, 43 minutes, and 21 seconds) as opposed to a point in time |
| CUser | Class which represents a system user |
| CAbstractMain | Base class for the PluginMain class, which runs the plugin |
| CError | Class which represents an error |
| CErrorLocation | Class which represents the location of an error |
| CErrorLock | A class which can be derived from in order to prevent child classes from being derived from further |
| CNoncopyable | Class which can be inherited from to disallow copying of its child classes |
| COptional | Container class which represents a value that may or may not be set |
| CSuccess | Class which represents a successful operation (i.e. no error) |
1.8.16