#include <external_launch.h>

Inheritance diagram for libpressio_launch_plugin:

Collaboration diagram for libpressio_launch_plugin:

Public Member Functions
virtual extern_proc_results	launch (std::vector< std::string > const &args) const =0

pressio_options	get_documentation () const final

virtual pressio_options	get_documentation_impl () const =0

virtual std::unique_ptr< libpressio_launch_plugin >	clone () const =0

Public Member Functions inherited from pressio_configurable
virtual const char *	prefix () const =0

std::string const &	get_name () const

virtual void	set_name (std::string const &new_name)

virtual void	set_name_impl (std::string const &new_name)

virtual struct pressio_options	get_configuration () const

virtual struct pressio_options	get_documentation () const

virtual int	check_options (struct pressio_options const &)

virtual struct pressio_options	get_options () const

virtual int	set_options (struct pressio_options const &options)

int	cast_options (pressio_options const &early_config, pressio_options const &config)

Public Member Functions inherited from pressio_errorable
const char *	error_msg () const

int	error_code () const

Additional Inherited Members
Protected Member Functions inherited from pressio_configurable
template<class StringType >
void	set (pressio_options &options, StringType const &key, pressio_option const &value) const

template<class StringType >
void	set_type (pressio_options &options, StringType const &key, pressio_option_type type) const

template<class StringType , class PointerType >
enum pressio_options_key_status	get (pressio_options const &options, StringType &&key, PointerType value) const

template<class StringType , class Wrapper , class... Args>
void	set_meta (pressio_options &options, StringType &&key, std::string const &current_id, Wrapper const &current_value, Args &&... args) const

template<class StringType , class Wrapper , class... Args>
void	set_meta_docs (pressio_options &options, StringType &&key, std::string const &docstring, Wrapper const &current_value, Args &&... args) const

template<class StringType , class Wrapper , class Registry , class... Args>
void	set_meta_configuration (pressio_options &options, StringType &&key, Registry const &registry, Wrapper const &current_value) const

template<class StringType , class Wrapper , class Registry , class... Args>
void	set_meta_many_configuration (pressio_options &options, StringType &&key, Registry const &registry, std::vector< Wrapper > const &current_values) const

template<class StringType , class Wrapper , class... Args>
void	set_meta_many_docs (pressio_options &options, StringType &&key, std::string const &docstring, std::vector< Wrapper > const &current_values, Args &&... args) const

template<class StringType , class Wrapper , class... Args>
void	set_meta_many (pressio_options &options, StringType &&key, std::vector< std::string > const &current_ids, std::vector< Wrapper > const &current_values, Args &&... args) const

template<class StringType , class Registry , class Wrapper >
pressio_options_key_status	get_meta (pressio_options const &options, StringType &&key, Registry const &registry, std::string &current_id, Wrapper &current_value)

template<class StringType , class Registry , class Wrapper >
pressio_options_key_status	get_meta_many (pressio_options const &options, StringType &&key, Registry const &registry, std::vector< std::string > &current_ids, std::vector< Wrapper > &current_values)

template<class T >
void	set_names_many (std::string const &name, std::vector< T > &plugins, std::vector< std::string > const &names) const

std::string	get_metrics_key_name () const

Protected Member Functions inherited from pressio_errorable
int	set_error (int code, std::string const &msg)

void	clear_error ()

Static Protected Member Functions inherited from pressio_configurable
static pressio_thread_safety	get_threadsafe (pressio_configurable const &c)

Protected Attributes inherited from pressio_configurable
std::string	name

Detailed Description

an extension point for launching processes

Member Function Documentation

◆ clone()

virtual std::unique_ptr< libpressio_launch_plugin > libpressio_launch_plugin::clone ( ) const

pure virtual

clones the launch method

Returns: a clone of the launcher

◆ get_documentation()

pressio_options libpressio_launch_plugin::get_documentation ( ) const

inlinefinalvirtual

get the documentation strings for a compressor

See also: pressio_compressor_get_documentation for the semantics this function should obey

Reimplemented from pressio_configurable.

◆ get_documentation_impl()

virtual pressio_options libpressio_launch_plugin::get_documentation_impl ( ) const

pure virtual

Returns: documentation for this launch plugin

◆ launch()

virtual extern_proc_results libpressio_launch_plugin::launch ( std::vector< std::string > const & args ) const

pure virtual

launch the process

Parameters

[in] args the arguments to launch the process

Returns: results of running the process

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

include/libpressio_ext/launch/external_launch.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ get_documentation()

◆ get_documentation_impl()

◆ launch()