Loading...
Searching...
No Matches
thrift_application_base.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2015 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef THRIFT_APPLICATION_BASE_H
#define THRIFT_APPLICATION_BASE_H
#include <gnuradio/api.h>
#include <gnuradio/logger.h>
#include <gnuradio/prefs.h>
#include <gnuradio/thread/thread.h>
#include <chrono>
#include <memory>
#include <thread>
namespace {
// Time, in milliseconds, to wait between checks to the Thrift runtime to see if
// it has fully initialized.
static constexpr unsigned int THRIFTAPPLICATION_ACTIVATION_TIMEOUT_MS(200);
}; // namespace
namespace apache {
namespace thrift {
namespace server {
class TServer;
}
} // namespace thrift
} // namespace apache
/*!
* \brief Class to be statically initialized by thrift_application_base. Used
* to store state for thrift_application_base's singleton functions.
*/
class thrift_application_base_impl
{
public:
thrift_application_base_impl()
: d_application_initialized(false), d_endpointStr(""), d_start_thrift_thread()
{
;
}
// Used to ensure the Thrift runtime is initialized on the first call to ::i().
bool d_application_initialized;
// Stores the generated endpoint string after the Thrift runtime has initialized.
std::string d_endpointStr;
// Thread to execute the Thrift runtime's blocking serve() function.
std::shared_ptr<gr::thread::thread> d_start_thrift_thread;
};
/*!
* \brief Base class for a Thrift application with a singleton with
* instance function thrift_application_base::i(). Lazy initialization
* is used to start the Thrift runtime, therefore the Thrift runtime
* is not started unless thrift_application_base::i() is called at
* least once. This typically means that at least one rpc variable
* must be registered by a block before the runtime will start.
*
* \param TserverBase Template parameter naming the type of the server
* base, which is typically rpcserverbase.
* \param TserverClass Template parameter naming the eventual type of
* the fully derived application.
* \param _app Reference to the fully derived application instance to
* be returned by thrift_application_base::i().
*/
template <typename TserverBase, typename TserverClass>
class thrift_application_base
{
public:
thrift_application_base(TserverClass* _app);
/*!
* Destructor for the application. Since shutdown and cleanup of the
* runtime is typically custom to a particular booter
* implementation, this must be implemented as a specialized function
* for a particular booter. Thus a template implementation is not
* provided here.
*/
~thrift_application_base();
/*!
* The application singleton instance function.
*/
static TserverBase* i();
/*!
* Returns the endpoint string of this application.
*/
static const std::vector<std::string> endpoints();
protected:
/*!
* Allows this application's booter to set the endpoint string after
* the Thrift runtime has initialized.
*
* \param[in] endpoint The endpoint string reported by this class.
*/
void set_endpoint(const std::string& endpoint);
virtual TserverBase* i_impl() = 0;
/*!
* Reference to the fully derived application instance.
*/
static TserverClass* d_application;
/*!
* Reference to the Thrift runtime.
*/
std::unique_ptr<apache::thrift::server::TServer> d_thriftserver;
/*!
* Max number of attempts when checking the Thrift runtime for
* Initialization before giving up. Set in the Thrift config file
* (see \ref ctrlport_thrift_prefs).
*/
static const unsigned int d_default_max_init_attempts;
/*!
* Default port for the runtime to listen on, if a static port is
* not specified. Set in the Thrift config file (see \ref
* ctrlport_thrift_prefs).
*/
static const unsigned int d_default_thrift_port;
/*!
* Maximum number of threads to create when serving multiple rpc
* clients. Set in the Thrift config file (see \ref
* ctrlport_thrift_prefs).
*/
static const unsigned int d_default_num_thrift_threads;
/*!
* Default packet size for the IP payload of thrift packets. Set in
* the Thrift config file (see \ref ctrlport_thrift_prefs).
*/
static const unsigned int d_default_thrift_buffer_size;
/*!
* <a href="https://wiki.gnuradio.org/index.php/Logging" target="_blank">Logging</a>
* instances.
*/
gr::logger_ptr d_logger, d_debug_logger;
private:
// Function to be called in a separate thread to invoke the blocking
// ThriftServer::serve() function. Must be specialized for a particular
// booter implementation, therefore a template implementation is
// not provided here.
void start_thrift();
// Non-blocking function that returns true when the Thrift
// runtime has finished initialization. Must be implemented
// as a specialized template function for a particular booter
// implementation, therefore template implementation is not
// provided here.
bool application_started();
// Internal function to start the initialization of the runtime.
// Since this singleton uses lazy instantiation, this function
// will be called on the first call to the instance function ::i(),
// and since ::i() is static, this function must be static as well.
static void start_application();
// Pointer to the structure containing statically allocated
// state information for the applicaiton_base singleton.
static std::unique_ptr<thrift_application_base_impl> p_impl;
// Mutex to protect the endpoint string.
gr::thread::mutex d_lock;
// Will be set to true by a the application_started() function,
// specialized for a particular booter implementation, once the
// thrift runtime has successfully initialized.
bool d_thirft_is_running;
};
template <typename TserverBase, typename TserverClass>
TserverClass* thrift_application_base<TserverBase, TserverClass>::d_application(0);
template <typename TserverBase, typename TserverClass>
thrift_application_base<TserverBase, TserverClass>::thrift_application_base(
TserverClass* _app)
: d_lock(), d_thirft_is_running(false)
{
gr::configure_default_loggers(d_logger, d_debug_logger, "controlport");
d_application = _app;
}
template <typename TserverBase, typename TserverClass>
void thrift_application_base<TserverBase, TserverClass>::start_application()
{
unsigned int max_init_attempts =
static_cast<unsigned int>(gr::prefs::singleton()->get_long(
"thrift", "init_attempts", d_default_max_init_attempts));
if (!p_impl->d_application_initialized) {
p_impl->d_start_thrift_thread = std::make_shared<gr::thread::thread>(
[app = d_application] { app->start_thrift(); });
bool app_started(false);
for (unsigned int attempts(0); (!app_started && attempts < max_init_attempts);
++attempts) {
std::this_thread::sleep_for(
std::chrono::milliseconds(THRIFTAPPLICATION_ACTIVATION_TIMEOUT_MS));
app_started = d_application->application_started();
}
if (!app_started) {
gr::logger log("thrift_application_base");
log.warn("start_application(): timeout waiting");
}
p_impl->d_application_initialized = true;
}
}
template <typename TserverBase, typename TserverClass>
const std::vector<std::string>
thrift_application_base<TserverBase, TserverClass>::endpoints()
{
std::vector<std::string> ep;
ep.push_back(p_impl->d_endpointStr);
return ep;
}
template <typename TserverBase, typename TserverClass>
void thrift_application_base<TserverBase, TserverClass>::set_endpoint(
const std::string& endpoint)
{
gr::thread::scoped_lock guard(d_lock);
p_impl->d_endpointStr = endpoint;
}
template <typename TserverBase, typename TserverClass>
TserverBase* thrift_application_base<TserverBase, TserverClass>::i()
{
if (!p_impl->d_application_initialized) {
start_application();
}
return d_application->i_impl();
}
#endif
gr::logger
GR_LOG macros.
Definition logger.h:121
gr::prefs::get_long
long get_long(const std::string &section, const std::string &option, long default_val)
If option exists and value can be converted to long, return it; else default_val.
gr::prefs::singleton
static prefs * singleton()
std::vector
STL class.
Definition vector_docstub.h:11
thrift_application_base_impl
Class to be statically initialized by thrift_application_base. Used to store state for thrift_applica...
Definition thrift_application_base.h:42
thrift_application_base_impl::d_endpointStr
std::string d_endpointStr
Definition thrift_application_base.h:53
thrift_application_base_impl::d_application_initialized
bool d_application_initialized
Definition thrift_application_base.h:51
thrift_application_base_impl::d_start_thrift_thread
std::shared_ptr< gr::thread::thread > d_start_thrift_thread
Definition thrift_application_base.h:55
thrift_application_base_impl::thrift_application_base_impl
thrift_application_base_impl()
Definition thrift_application_base.h:44
thrift_application_base
Base class for a Thrift application with a singleton with instance function thrift_application_base::...
Definition thrift_application_base.h:76
thrift_application_base::d_default_thrift_buffer_size
static const unsigned int d_default_thrift_buffer_size
Definition thrift_application_base.h:145
thrift_application_base::d_logger
gr::logger_ptr d_logger
Definition thrift_application_base.h:151
thrift_application_base::thrift_application_base
thrift_application_base(TserverClass *_app)
Definition thrift_application_base.h:190
thrift_application_base::d_thriftserver
std::unique_ptr< apache::thrift::server::TServer > d_thriftserver
Definition thrift_application_base.h:118
thrift_application_base::set_endpoint
void set_endpoint(const std::string &endpoint)
Definition thrift_application_base.h:236
thrift_application_base::d_default_num_thrift_threads
static const unsigned int d_default_num_thrift_threads
Definition thrift_application_base.h:139
thrift_application_base::endpoints
static const std::vector< std::string > endpoints()
Definition thrift_application_base.h:228
thrift_application_base::d_application
static TserverClass * d_application
Definition thrift_application_base.h:113
thrift_application_base::d_default_thrift_port
static const unsigned int d_default_thrift_port
Definition thrift_application_base.h:132
thrift_application_base::i_impl
virtual TserverBase * i_impl()=0
thrift_application_base::d_default_max_init_attempts
static const unsigned int d_default_max_init_attempts
Definition thrift_application_base.h:125
thrift_application_base::~thrift_application_base
~thrift_application_base()
thrift_application_base::i
static TserverBase * i()
Definition thrift_application_base.h:244
thrift_application_base::d_debug_logger
gr::logger_ptr d_debug_logger
Definition thrift_application_base.h:151
api.h
logger.h
apache
Definition thrift_application_base.h:28
gr::thread::mutex
boost::mutex mutex
Definition thread.h:37
gr::thread::scoped_lock
boost::unique_lock< boost::mutex > scoped_lock
Definition thread.h:38
gr::logger_ptr
std::shared_ptr< logger > logger_ptr
Definition logger.h:250
gr::configure_default_loggers
GR_RUNTIME_API bool configure_default_loggers(gr::logger_ptr &l, gr::logger_ptr &d, const std::string &name)
prefs.h
thread.h