diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 12:15:43 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 12:15:43 +0000 |
commit | f5f56e1a1c4d9e9496fcb9d81131066a964ccd23 (patch) | |
tree | 49e44c6f87febed37efb953ab5485aa49f6481a7 /src/lib/hooks/tests/full_callout_library.cc | |
parent | Initial commit. (diff) | |
download | isc-kea-f5f56e1a1c4d9e9496fcb9d81131066a964ccd23.tar.xz isc-kea-f5f56e1a1c4d9e9496fcb9d81131066a964ccd23.zip |
Adding upstream version 2.4.1.upstream/2.4.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/lib/hooks/tests/full_callout_library.cc')
-rw-r--r-- | src/lib/hooks/tests/full_callout_library.cc | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/src/lib/hooks/tests/full_callout_library.cc b/src/lib/hooks/tests/full_callout_library.cc new file mode 100644 index 0000000..58ea8c7 --- /dev/null +++ b/src/lib/hooks/tests/full_callout_library.cc @@ -0,0 +1,177 @@ +// Copyright (C) 2013-2020 Internet Systems Consortium, Inc. ("ISC") +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +/// @file +/// @brief Full callout library +/// +/// This is source of a test library for various test (LibraryManager and +/// HooksManager). The characteristics of the library produced from this +/// file are: +/// +/// The characteristics of this library are: +/// +/// - All four framework functions are supplied (version(), load(), +/// unload() and multi_threading_compatible()), with unload() +/// creating a marker file. The test code checks for the presence +/// of this file, so verifying that unload() has been run. +/// +/// - One standard and two non-standard callouts are supplied, with the latter +/// being registered by the load() function. +/// +/// All callouts do trivial calculations, the result of all being called in +/// sequence being +/// +/// @f[ ((7 * data_1) - data_2) * data_3 @f] +/// +/// ...where data_1, data_2 and data_3 are the values passed in arguments of +/// the same name to the three callouts (data_1 passed to hookpt_one, data_2 +/// to hookpt_two etc.) and the result is returned in the argument "result". + +#include <config.h> + +#include <hooks/hooks.h> +#include <hooks/tests/marker_file.h> + +#include <fstream> + +using namespace isc::hooks; + +extern "C" { + +// Callouts + +int +context_create(CalloutHandle& handle) { + handle.setContext("result", static_cast<int>(7)); + handle.setArgument("result", static_cast<int>(7)); + return (0); +} + +// First callout adds the passed "data_1" argument to the initialized context +// value of 7. (Note that the value set by context_create is accessed through +// context and not the argument, so checking that context is correctly passed +// between callouts in the same library.) + +int +hookpt_one(CalloutHandle& handle) { + int data; + handle.getArgument("data_1", data); + + int result; + handle.getArgument("result", result); + + result *= data; + handle.setArgument("result", result); + + return (0); +} + +// Second callout subtracts the passed value of data_2 from the current +// running total. + +static int +hook_nonstandard_two(CalloutHandle& handle) { + int data; + handle.getArgument("data_2", data); + + int result; + handle.getArgument("result", result); + + result -= data; + handle.setArgument("result", result); + + return (0); +} + +// Final callout multiplies the current running total by data_3. + +static int +hook_nonstandard_three(CalloutHandle& handle) { + int data; + handle.getArgument("data_3", data); + + int result; + handle.getArgument("result", result); + + result *= data; + handle.setArgument("result", result); + + return (0); +} + +// First command handler assigns data to a result. + +static int +command_handler_one(CalloutHandle& handle) { + int data; + handle.getArgument("data_1", data); + + int result; + handle.getArgument("result", result); + + result = data; + handle.setArgument("result", result); + + return (0); +} + +// Second command handler multiples the result by data by 10. + +static int +command_handler_two(CalloutHandle& handle) { + int data; + handle.getArgument("data_2", data); + + int result; + handle.getArgument("result", result); + + result *= data * 10; + handle.setArgument("result", result); + + return (0); +} + +// Framework functions + +int +version() { + return (KEA_HOOKS_VERSION); +} + +int +load(LibraryHandle& handle) { + // Initialize if the main image was statically linked +#ifdef USE_STATIC_LINK + hooksStaticLinkInit(); +#endif + // Register the non-standard functions + handle.registerCallout("hookpt_two", hook_nonstandard_two); + handle.registerCallout("hookpt_three", hook_nonstandard_three); + + // Register command_handler_one as control command handler. + handle.registerCommandCallout("command-one", command_handler_one); + handle.registerCommandCallout("command-two", command_handler_two); + + return (0); +} + +int +unload() { + // Create the marker file. + std::fstream marker; + marker.open(MARKER_FILE, std::fstream::out); + marker.close(); + + return (0); +} + +int +multi_threading_compatible() { + return (1); +} + +}; + |