adc::publisher_api Class Reference

Publisher plugin interface. More...

#include <publisher.hpp>

Inheritance diagram for adc::publisher_api:

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

Detailed Description

Publisher plugin interface.

Life-cycle of a plugin:

• p is created by a call to the factory. (there may be more than one instance per name).
• p->config is called 0 or 1 times (plugins must have reasonable default behavior).
• p->initialize is called exactly once
• p->publish is called 0 or more times
  • optionally, to enable dynamic application control of enabled logging:
    • p->pause is called to suppress emissions from subsequent calls to p->publish.
    • p->resume is called to unsuppress emissions from subsequent calls to p->publish.
• p->finalize is called.

A publisher object should not be assumed thread-safe. In particular, there may be conflicts among config/initialize/publish/finalize calls across multiple threads. Publishers which are thread-safe will document that fact individually.

Definition at line 43 of file publisher.hpp.

Constructor & Destructor Documentation

~publisher_api()

virtual adc::publisher_api::~publisher_api ( )

inlinevirtual

Definition at line 46 of file publisher.hpp.

Member Function Documentation

name()

virtual std::string_view adc::publisher_api::name ( ) const

pure virtual

Returns

the name of the plugin

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::none_plugin, adc::script_plugin, adc::stdout_plugin, and adc::syslog_plugin.

version()

virtual std::string_view adc::publisher_api::version ( ) const

pure virtual

Returns

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

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::none_plugin, adc::script_plugin, adc::stdout_plugin, and adc::syslog_plugin.

publish()

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

pure virtual

Publish the content of the builder.

Parameters

b	converted to a single json object and published

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::script_plugin, adc::stdout_plugin, adc::syslog_plugin, and adc::none_plugin.

config() [1/2]

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

pure virtual

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.

Implemented in adc::none_plugin, adc::stdout_plugin, adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::script_plugin, and adc::syslog_plugin.

config() [2/2]

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

pure virtual

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.

Implemented in adc::none_plugin, adc::stdout_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::multifile_plugin, adc::script_plugin, adc::syslog_plugin, adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, and adc::ldmsd_stream_publish_plugin.

get_option_defaults()

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

pure virtual

Look up the settable options and their defaults.

Some plugins without options will return an empty map.

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::none_plugin, adc::script_plugin, adc::stdout_plugin, and adc::syslog_plugin.

initialize()

virtual int adc::publisher_api::initialize ( )

pure virtual

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

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::none_plugin, adc::script_plugin, adc::stdout_plugin, and adc::syslog_plugin.

finalize()

virtual void adc::publisher_api::finalize ( )

pure virtual

Stop publishing and release any resources held for managing publication.

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::none_plugin, adc::script_plugin, adc::stdout_plugin, and adc::syslog_plugin.

pause()

virtual void adc::publisher_api::pause ( )

pure virtual

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

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::none_plugin, adc::script_plugin, adc::stdout_plugin, and adc::syslog_plugin.

resume()

virtual void adc::publisher_api::resume ( )

pure virtual

Resume publishing Duplicate calls are allowed.

Implemented in adc::curl_plugin, adc::file_plugin, adc::ldms_message_publish_plugin, adc::ldmsd_stream_publish_plugin, adc::libadiak_json_plugin, adc::libadiak_many_plugin, adc::libcurl_plugin, adc::libldms_msg_publish_plugin, adc::multifile_plugin, adc::none_plugin, adc::script_plugin, adc::stdout_plugin, and adc::syslog_plugin.

---

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

• adc/publisher/publisher.hpp