RestHandler Class Reference

The RESTful API handler. More...

#include <RestHandler.h>

Collaboration diagram for RestHandler:

Classes
class	ChannelInfo
	RX Info pertaining to an SCH (MCCH/MCH or PDSCH) More...

Public Types
typedef std::function< void(const std::string &antenna, unsigned fcen, double gain, unsigned sample_rate, unsigned bandwidth)>	set_params_t
	Definition of the callback for setting new reception parameters.

Public Member Functions
	RestHandler (const libconfig::Config &cfg, const std::string &url, state_t &state, LimeSdrReader &lime, Phy &phy, set_params_t set_params)
	Default constructor. More...
virtual	~RestHandler ()
	Default destructor.
float	cinr_db ()
	Current CINR value.
void	add_cinr_value (float cinr)

Public Attributes
std::vector< uint8_t >	_ce_values = {}
	Time domain subcarrier CE values.
ChannelInfo	_pdsch
	RX info for PDSCH.
ChannelInfo	_mcch
	RX info for MCCH.
std::map< uint32_t, ChannelInfo >	_mch
	RX info for MCHs.

Detailed Description

The RESTful API handler.

Supports GET and PUT verbs for SDR parameters, and GET for reception info

Definition at line 47 of file RestHandler.h.

Constructor & Destructor Documentation

RestHandler()

RestHandler::RestHandler	(	const libconfig::Config &	cfg,
		const std::string &	url,
		state_t &	state,
		LimeSdrReader &	lime,
		Phy &	phy,
		set_params_t	set_params
	)

Default constructor.

Parameters

cfg	Config singleton reference
url	URL to open the server on
state	Reference to the main loop sate
lime	Reference to the LimeSDR reader
set_params	Set parameters callback

Definition at line 35 of file RestHandler.cpp.

    : _cfg(cfg),
      _state(state),
      _lime(lime),
      _phy(phy),
      _set_params(std::move(set_params)) {
 
  http_listener_config server_config;
  if (url.rfind("https", 0) == 0) {
    server_config.set_ssl_context_callback(
        [&](boost::asio::ssl::context& ctx) {
          std::string cert_file = "/usr/share/obeca/cert.pem";
          cfg.lookupValue("restful_api.cert", cert_file);
 
          std::string key_file = "/usr/share/obeca/key.pem";
          cfg.lookupValue("restful_api.key", key_file);
 
          ctx.set_options(boost::asio::ssl::context::default_workarounds);
          ctx.use_certificate_chain_file(cert_file);
          ctx.use_private_key_file(key_file, boost::asio::ssl::context::pem);
        });
  }
 
  cfg.lookupValue("restful_api.api_key.enabled", _require_bearer_token);
  if (_require_bearer_token) {
    _api_key = "106cd60-76c8-4c37-944c-df21aa690c1e";
    cfg.lookupValue("restful_api.api_key.key", _api_key);
  }
 
  _listener = std::make_unique<http_listener>(
      url, server_config);
 
  _listener->support(methods::GET, std::bind(&RestHandler::get, this, std::placeholders::_1));  // NOLINT
  _listener->support(methods::PUT, std::bind(&RestHandler::put, this, std::placeholders::_1));  // NOLINT
 
  _listener->open().wait();
}

---

The documentation for this class was generated from the following files:

• src/RestHandler.h
• src/RestHandler.cpp