adc::libcurl_plugin Class Reference

NOT yet implemented publisher plugin that will eventually use libcurl. More...

Inheritance diagram for adc::libcurl_plugin:

Collaboration diagram for adc::libcurl_plugin:

Public Member Functions
	libcurl_plugin ()
int	publish (std::shared_ptr< builder_api > b)
	NOT IMPLEMENTED .libcurl_plugin::libcurl_send pending.
int	config (const std::map< std::string, std::string > &m)
	Configure the plugin with the options given.
int	config (const std::map< std::string, std::string > &m, std::string_view env_prefix)
	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.
string_view	name () const
string_view	version () const
	~libcurl_plugin ()

Detailed Description

NOT yet implemented publisher plugin that will eventually use libcurl.

Definition at line 29 of file libcurl.ipp.

Constructor & Destructor Documentation

libcurl_plugin()

adc::libcurl_plugin::libcurl_plugin ( )

inline

Definition at line 104 of file libcurl.ipp.

~libcurl_plugin()

adc::libcurl_plugin::~libcurl_plugin ( )

inline

Definition at line 187 of file libcurl.ipp.

Member Function Documentation

publish()

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

inlinevirtual

NOT IMPLEMENTED .libcurl_plugin::libcurl_send pending.

Implements adc::publisher_api.

Definition at line 109 of file libcurl.ipp.

config() [1/2]

int adc::libcurl_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 121 of file libcurl.ipp.

config() [2/2]

int adc::libcurl_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 125 of file libcurl.ipp.

get_option_defaults()

const std::map< const std::string, const std::string > & adc::libcurl_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 131 of file libcurl.ipp.

initialize()

int adc::libcurl_plugin::initialize ( )

inlinevirtual

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

Implements adc::publisher_api.

Definition at line 135 of file libcurl.ipp.

finalize()

void adc::libcurl_plugin::finalize ( )

inlinevirtual

Stop publishing and release any resources held for managing publication.

Implements adc::publisher_api.

Definition at line 161 of file libcurl.ipp.

pause()

void adc::libcurl_plugin::pause ( )

inlinevirtual

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

Implements adc::publisher_api.

Definition at line 171 of file libcurl.ipp.

resume()

void adc::libcurl_plugin::resume ( )

inlinevirtual

Resume publishing Duplicate calls are allowed.

Implements adc::publisher_api.

Definition at line 175 of file libcurl.ipp.

name()

string_view adc::libcurl_plugin::name ( ) const

inlinevirtual

Returns

the name of the plugin

Implements adc::publisher_api.

Definition at line 179 of file libcurl.ipp.

version()

string_view adc::libcurl_plugin::version ( ) const

inlinevirtual

Returns

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

Implements adc::publisher_api.

Definition at line 183 of file libcurl.ipp.

---

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

• adc/publisher/impl/libcurl.ipp