diff options
author | max42 <max42@yandex-team.com> | 2023-07-29 00:02:16 +0300 |
---|---|---|
committer | max42 <max42@yandex-team.com> | 2023-07-29 00:02:16 +0300 |
commit | 73b89de71748a21e102d27b9f3ed1bf658766cb5 (patch) | |
tree | 188bbd2d622fa91cdcbb1b6d6d77fbc84a0646f5 /yt/cpp/mapreduce/interface/init.h | |
parent | 528e321bcc2a2b67b53aeba58c3bd88305a141ee (diff) | |
download | ydb-73b89de71748a21e102d27b9f3ed1bf658766cb5.tar.gz |
YT-19210: expose YQL shared library for YT.
After this, a new target libyqlplugin.so appears. in open-source cmake build.
Diff in open-source YDB repo looks like the following: https://paste.yandex-team.ru/f302bdb4-7ef2-4362-91c7-6ca45f329264
Diffstat (limited to 'yt/cpp/mapreduce/interface/init.h')
-rw-r--r-- | yt/cpp/mapreduce/interface/init.h | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/yt/cpp/mapreduce/interface/init.h b/yt/cpp/mapreduce/interface/init.h new file mode 100644 index 00000000000..302be268fc4 --- /dev/null +++ b/yt/cpp/mapreduce/interface/init.h @@ -0,0 +1,71 @@ +#pragma once + +/// +/// @file yt/cpp/mapreduce/interface/init.h +/// +/// Initialization functions of YT Wrapper. + +#include <yt/cpp/mapreduce/interface/wait_proxy.h> + +#include <util/generic/fwd.h> + +#include <functional> + +namespace NYT { + +//////////////////////////////////////////////////////////////////////////////// + +/// Options for @ref NYT::Initialize() and @ref NYT::JoblessInitialize() functions +struct TInitializeOptions +{ + using TSelf = TInitializeOptions; + + /// + /// @brief Override waiting functions for YT Wrapper. + /// + /// This options allows to override functions used by this library to wait something. + FLUENT_FIELD_DEFAULT(::TIntrusivePtr<IWaitProxy>, WaitProxy, nullptr); + + /// + /// @brief Enable/disable cleanup when program execution terminates abnormally. + /// + /// When set to true, library will abort all active transactions and running operations when program + /// terminates on error or signal. + FLUENT_FIELD_DEFAULT(bool, CleanupOnTermination, false); + + /// + /// @brief Set callback to be called before exit() in job mode. + /// + /// Provided function will be called just before exit() when program is started in job mode. + /// This might be useful for shutting down libraries that are used inside operations. + /// + /// NOTE: Keep in mind that inside job execution environment differs from client execution environment. + /// So JobOnExitFunction should not depend on argc/argv environment variables etc. + FLUENT_FIELD_OPTION(std::function<void()>, JobOnExitFunction); +}; + +/// +/// @brief Performs basic initialization (logging, termination handlers, etc). +/// +/// This function never switches to job mode. +void JoblessInitialize(const TInitializeOptions& options = TInitializeOptions()); + +/// +/// @brief Performs basic initialization and switches to a job mode if required. +/// +/// This function performs basic initialization (it sets up logging reads the config, etc) and checks if binary is launched +/// on YT machine inside a job. If latter is true this function launches proper job and after job is done it calls exit(). +/// +/// This function must be called if application starts any operation. +/// This function must be called immediately after entering main() function before any argument parsing is done. +void Initialize(int argc, const char **argv, const TInitializeOptions &options = TInitializeOptions()); + +/// Similar to @ref NYT::Initialize(int, const char**, const TInitializeOptions&) +void Initialize(int argc, char **argv, const TInitializeOptions &options = TInitializeOptions()); + +/// Similar to @ref NYT::Initialize(int, const char**, const TInitializeOptions&) +void Initialize(const TInitializeOptions &options = TInitializeOptions()); + +//////////////////////////////////////////////////////////////////////////////// + +} // namespace NYT |