mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 14:05:33 +00:00
Code Issues Releases Wiki Activity

[2281] Add documentation for the static datasource shared object's public symbols

Browse Source
This commit is contained in:
Mukund Sivaraman
2013-02-12 10:00:21 +05:30
parent d7f14ea88e
commit cfd00e9403
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/lib/datasrc/static_datasrc.h
View File

@@ -24,9 +24,20 @@
namespace isc {
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,
std::string& error);
/// \brief Destroy the instance created by createInstance()
extern "C" void destroyInstance(DataSourceClient* instance);
}