mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-09-03 23:45:27 +00:00
[2281] Add documentation for the static datasource shared object's public symbols
This commit is contained in:
@@ -24,9 +24,20 @@
|
|||||||
namespace isc {
|
namespace isc {
|
||||||
namespace datasrc {
|
namespace datasrc {
|
||||||
|
|
||||||
|
/// \brief Creates an instance of the static datasource client
|
||||||
|
///
|
||||||
|
/// Currently the configuration passed here must be a StringElement,
|
||||||
|
/// containing the path to a zone file for the BIND./CH zone.
|
||||||
|
///
|
||||||
|
/// \param config The configuration for the datasource instance (see above)
|
||||||
|
/// \param error This string will be set to an error message if an error occurs
|
||||||
|
/// during initialization
|
||||||
|
/// \return An instance of the static datasource client, or NULL if there was
|
||||||
|
/// an error
|
||||||
extern "C" DataSourceClient* createInstance(isc::data::ConstElementPtr config,
|
extern "C" DataSourceClient* createInstance(isc::data::ConstElementPtr config,
|
||||||
std::string& error);
|
std::string& error);
|
||||||
|
|
||||||
|
/// \brief Destroy the instance created by createInstance()
|
||||||
extern "C" void destroyInstance(DataSourceClient* instance);
|
extern "C" void destroyInstance(DataSourceClient* instance);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user