cl_http::CpHttpRequestExecutor Class Reference

#include <cp_http_request_executor.hpp>

Inheritance diagram for cl_http::CpHttpRequestExecutor:

Collaboration diagram for cl_http::CpHttpRequestExecutor:

Public Types
enum class	HttpMethod { GET = static_cast<int>(boost::beast::http::verb::get) , POST = static_cast<int>(boost::beast::http::verb::post) , PUT = static_cast<int>(boost::beast::http::verb::put) }
using	TResponse = http_session_base::TResponse

Public Member Functions
	CpHttpRequestExecutor ()
virtual	~CpHttpRequestExecutor ()
void	onInitialize () override
void	setDependencies (CpHttpConnectionManager *connMgr, CpHttpSessionManager *sessMgr)
void	executeRequest (const HttpMethod method, const std::string &path="/", const std::string &body="", const std::unordered_map< std::string, std::string > &headers={})
Public Member Functions inherited from smacc2::ISmaccComponent
	ISmaccComponent ()
virtual	~ISmaccComponent ()
virtual std::string	getName () const

Public Attributes
smacc2::SmaccSignal< void(const TResponse &)>	onResponseReceived_

Private Attributes
CpHttpConnectionManager *	connectionManager_
CpHttpSessionManager *	sessionManager_
std::function< void(TResponse)>	responseHandler_

Static Private Attributes
static constexpr int	HTTP_VERSION = 11

Additional Inherited Members
Protected Member Functions inherited from smacc2::ISmaccComponent
template<typename TOrthogonal , typename TClient >
void	onComponentInitialization ()
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
template<typename TComponent >
void	requiresComponent (TComponent *&requiredComponentStorage, ComponentRequirement requirementType=ComponentRequirement::SOFT)
template<typename TComponent >
void	requiresComponent (std::string name, TComponent *&requiredComponentStorage, ComponentRequirement requirementType=ComponentRequirement::SOFT)
template<typename TClient >
void	requiresClient (TClient *&requiredClientStorage)
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createSiblingComponent (TArgs... targs)
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createSiblingNamedComponent (std::string name, TArgs... targs)
rclcpp::Node::SharedPtr	getNode ()
rclcpp::Logger	getLogger () const
ISmaccStateMachine *	getStateMachine ()
Protected Attributes inherited from smacc2::ISmaccComponent
ISmaccStateMachine *	stateMachine_
ISmaccClient *	owner_

Detailed Description

Definition at line 36 of file cp_http_request_executor.hpp.

Member Typedef Documentation

TResponse

using cl_http::CpHttpRequestExecutor::TResponse = http_session_base::TResponse

Definition at line 47 of file cp_http_request_executor.hpp.

Member Enumeration Documentation

HttpMethod

enum class cl_http::CpHttpRequestExecutor::HttpMethod

strong

Enumerator
GET
POST
PUT

Definition at line 40 of file cp_http_request_executor.hpp.

  {
    GET = static_cast<int>(boost::beast::http::verb::get),
    POST = static_cast<int>(boost::beast::http::verb::post),
    PUT = static_cast<int>(boost::beast::http::verb::put),
  };

Constructor & Destructor Documentation

CpHttpRequestExecutor()

cl_http::CpHttpRequestExecutor::CpHttpRequestExecutor

(

)

Definition at line 28 of file cp_http_request_executor.cpp.

: connectionManager_(nullptr), sessionManager_(nullptr)
{
  responseHandler_ = [this](const TResponse & res) { onResponseReceived_(res); };
}

References onResponseReceived_, and responseHandler_.

~CpHttpRequestExecutor()

cl_http::CpHttpRequestExecutor::~CpHttpRequestExecutor ( )

virtual

Definition at line 34 of file cp_http_request_executor.cpp.

{}

Member Function Documentation

executeRequest()

void cl_http::CpHttpRequestExecutor::executeRequest	(	const HttpMethod	method,
		const std::string &	path = "/",
		const std::string &	body = "",
		const std::unordered_map< std::string, std::string > &	headers = {} )

Definition at line 41 of file cp_http_request_executor.cpp.

{
  auto path_used = path;
  if (path.empty() || path[0] != '/')
  {
    path_used = "/" + path;
  }
 
  RCLCPP_INFO(
    this->getLogger(), "Executing request: SSL=%d Server=%s Path=%s Port=%s",
    sessionManager_->isSSL(), sessionManager_->getServerName().c_str(), path_used.c_str(),
    sessionManager_->getPort().c_str());
 
  auto executor = connectionManager_->getStrand();
  auto session = sessionManager_->createSession(executor, responseHandler_);
 
  session->setBody(body);
  session->setHeaders(headers);
  session->run(
    sessionManager_->getServerName(), path_used, static_cast<boost::beast::http::verb>(method),
    HTTP_VERSION);
}

References connectionManager_, cl_http::CpHttpSessionManager::createSession(), smacc2::ISmaccComponent::getLogger(), cl_http::CpHttpSessionManager::getPort(), cl_http::CpHttpSessionManager::getServerName(), cl_http::CpHttpConnectionManager::getStrand(), HTTP_VERSION, cl_http::CpHttpSessionManager::isSSL(), responseHandler_, and sessionManager_.

Referenced by cl_http::CbHttpRequestBase::onEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

onInitialize()

void cl_http::CpHttpRequestExecutor::onInitialize ( )

overridevirtual

Reimplemented from smacc2::ISmaccComponent.

Definition at line 36 of file cp_http_request_executor.cpp.

{
  // Dependencies set via setDependencies() before onInitialize() is called
}

setDependencies()

void cl_http::CpHttpRequestExecutor::setDependencies ( CpHttpConnectionManager * connMgr, CpHttpSessionManager * sessMgr )

inline

Definition at line 55 of file cp_http_request_executor.hpp.

  {
    connectionManager_ = connMgr;
    sessionManager_ = sessMgr;
  }

References connectionManager_, and sessionManager_.

Referenced by cl_http::ClHttp::onComponentInitialization().

Here is the caller graph for this function:

Member Data Documentation

connectionManager_

CpHttpConnectionManager* cl_http::CpHttpRequestExecutor::connectionManager_

private

Definition at line 72 of file cp_http_request_executor.hpp.

Referenced by executeRequest(), and setDependencies().

HTTP_VERSION

int cl_http::CpHttpRequestExecutor::HTTP_VERSION = 11

staticconstexprprivate

Definition at line 70 of file cp_http_request_executor.hpp.

Referenced by executeRequest().

onResponseReceived_

smacc2::SmaccSignal<void(const TResponse &)> cl_http::CpHttpRequestExecutor::onResponseReceived_

Definition at line 67 of file cp_http_request_executor.hpp.

Referenced by CpHttpRequestExecutor(), and cl_http::CbHttpRequestBase::runtimeConfigure().

responseHandler_

std::function<void(TResponse)> cl_http::CpHttpRequestExecutor::responseHandler_

private

Definition at line 75 of file cp_http_request_executor.hpp.

Referenced by CpHttpRequestExecutor(), and executeRequest().

sessionManager_

CpHttpSessionManager* cl_http::CpHttpRequestExecutor::sessionManager_

private

Definition at line 73 of file cp_http_request_executor.hpp.

Referenced by executeRequest(), and setDependencies().

---

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

• smacc2_client_library/cl_http/include/cl_http/components/cp_http_request_executor.hpp
• smacc2_client_library/cl_http/src/cl_http/components/cp_http_request_executor.cpp