adc::stdout_plugin Class Reference

Terminal output publisher_api implementation. This plugin sends messages to stdout synchronously. Multiple independent instances of this plugin may be used simultaneously, but message integrity depends on the behavior of stdout. More...

Inheritance diagram for adc::stdout_plugin:

Collaboration diagram for adc::stdout_plugin:

Public Member Functions
	stdout_plugin ()
int	publish (std::shared_ptr< builder_api > b)
	Publish the content of the builder.
int	config (const std::map< std::string, std::string > &)
	Configure the plugin with the options given.
int	config (const std::map< std::string, std::string > &, std::string_view)
	Configure the plugin with the options given and the corresponding environment variables.
const std::map< const std::string, const std::string > &	get_option_defaults ()
	Look up the settable options and their defaults.
int	initialize ()
	Ready the plugin to publish following the configuration options set or defaulted.
void	finalize ()
	Stop publishing and release any resources held for managing publication.
void	pause ()
	Pause publishing until a call to resume. Duplicate calls are allowed.
void	resume ()
	Resume publishing Duplicate calls are allowed.
std::string_view	name () const
std::string_view	version () const
	~stdout_plugin ()

Detailed Description

Terminal output publisher_api implementation. This plugin sends messages to stdout synchronously. Multiple independent instances of this plugin may be used simultaneously, but message integrity depends on the behavior of stdout.

Definition at line 17 of file stdout.ipp.

Constructor & Destructor Documentation

stdout_plugin()

adc::stdout_plugin::stdout_plugin ( )

inline

Definition at line 30 of file stdout.ipp.

~stdout_plugin()

adc::stdout_plugin::~stdout_plugin ( )

inline

Definition at line 76 of file stdout.ipp.

Member Function Documentation

publish()

int adc::stdout_plugin::publish ( std::shared_ptr< builder_api >  b )

inlinevirtual

Publish the content of the builder.

Parameters

b	converted to a single json object and published

Implements adc::publisher_api.

Definition at line 32 of file stdout.ipp.

config() [1/2]

int adc::stdout_plugin::config ( const std::map< std::string, std::string > &  m )

inlinevirtual

Configure the plugin with the options given.

Parameters

m	a map with keys documented in the plugin-specific header.

For plugin QQQ, Environment variables ADC_QQQ_PLUGIN_* will override the source code default for any key not defined in m. Here QQQ is the uppercase version of the plugin name.

Implements adc::publisher_api.

Definition at line 41 of file stdout.ipp.

config() [2/2]

int adc::stdout_plugin::config ( const std::map< std::string, std::string > &  m, std::string_view  env_prefix  )

inlinevirtual

Configure the plugin with the options given and the corresponding environment variables.

Parameters

m	a map with keys documented in the plugin-specific header.
env_prefix	is prepended to the expected keys for the plugin and values found with getenv that match are used, overriding elements of m. Typically, env_prefix will be PPP_ADC_QQQ_PLUGIN_ if application PPP wants to override the defaults of plugin QQQ. Here QQQ is the uppercase version of the plugin name.

Implements adc::publisher_api.

Definition at line 45 of file stdout.ipp.

get_option_defaults()

const std::map< const std::string, const std::string > & adc::stdout_plugin::get_option_defaults ( )

inlinevirtual

Look up the settable options and their defaults.

Some plugins without options will return an empty map.

Implements adc::publisher_api.

Definition at line 49 of file stdout.ipp.

initialize()

int adc::stdout_plugin::initialize ( )

inlinevirtual

Ready the plugin to publish following the configuration options set or defaulted.

Implements adc::publisher_api.

Definition at line 53 of file stdout.ipp.

finalize()

void adc::stdout_plugin::finalize ( )

inlinevirtual

Stop publishing and release any resources held for managing publication.

Implements adc::publisher_api.

Definition at line 57 of file stdout.ipp.

pause()

void adc::stdout_plugin::pause ( )

inlinevirtual

Pause publishing until a call to resume. Duplicate calls are allowed.

Implements adc::publisher_api.

Definition at line 60 of file stdout.ipp.

resume()

void adc::stdout_plugin::resume ( )

inlinevirtual

Resume publishing Duplicate calls are allowed.

Implements adc::publisher_api.

Definition at line 64 of file stdout.ipp.

name()

std::string_view adc::stdout_plugin::name ( ) const

inlinevirtual

Returns

the name of the plugin

Implements adc::publisher_api.

Definition at line 68 of file stdout.ipp.

version()

std::string_view adc::stdout_plugin::version ( ) const

inlinevirtual

Returns

the version of the plugin (should follow semantic versioning practices)

Implements adc::publisher_api.

Definition at line 72 of file stdout.ipp.

---

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

• adc/publisher/impl/stdout.ipp