cl_http::ClHttp Class Reference

HTTP/HTTPS client with pure component-based architecture. More...

#include <cl_http.hpp>

Inheritance diagram for cl_http::ClHttp:

Collaboration diagram for cl_http::ClHttp:

Public Types
enum class	kHttpRequestMethod { 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
	ClHttp (const std::string &server, const int &timeout=1500)
virtual	~ClHttp ()
void	onInitialize () override
template<typename TOrthogonal , typename TClient >
void	onComponentInitialization ()
Public Member Functions inherited from smacc2::ISmaccClient
	ISmaccClient ()
virtual	~ISmaccClient ()
virtual std::string	getName () const
template<typename TComponent >
TComponent *	getComponent ()
template<typename TComponent >
TComponent *	getComponent (std::string name)
template<typename TComponent >
TComponent *	getComponent (int index)
virtual smacc2::introspection::TypeInfo::Ptr	getType ()
ISmaccStateMachine *	getStateMachine ()
template<typename TSmaccSignal , typename T >
void	connectSignal (TSmaccSignal &signal, void(T::*callback)(), T *object)
template<typename SmaccClientType >
void	requiresClient (SmaccClientType *&storage)
void	getComponents (std::vector< std::shared_ptr< ISmaccComponent > > &components)
const std::vector< std::shared_ptr< ISmaccComponent > > &	iterateComponents () const
template<typename EventType >
void	postEvent (const EventType &ev)
template<typename EventType >
void	postEvent ()

Private Attributes
const int	HTTP_VERSION = 11
bool	initialized_
std::string	server_url_
CpHttpConnectionManager *	connectionManager_
CpHttpSessionManager *	sessionManager_
CpHttpRequestExecutor *	requestExecutor_

Additional Inherited Members
Protected Member Functions inherited from smacc2::ISmaccClient
template<typename TOrthogonal , typename TClient >
void	onComponentInitialization ()
template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createComponent (TArgs... targs)
template<typename SmaccComponentType , typename TOrthogonal , typename TClient , typename... TArgs>
SmaccComponentType *	createNamedComponent (std::string name, TArgs... targs)
rclcpp::Node::SharedPtr	getNode ()
rclcpp::Logger	getLogger ()
Protected Attributes inherited from smacc2::ISmaccClient
std::map< ComponentKey, std::shared_ptr< smacc2::ISmaccComponent > >	components_

Detailed Description

HTTP/HTTPS client with pure component-based architecture.

This client acts as a minimal orchestrator that creates and configures three specialized components during initialization. All HTTP functionality is delegated to components.

Components created:

• CpHttpConnectionManager: Manages io_context and worker thread
• CpHttpSessionManager: Manages SSL context and creates sessions
• CpHttpRequestExecutor: Executes requests and emits response signals

Behaviors should access CpHttpRequestExecutor directly via requiresComponent() rather than using the client interface.

Definition at line 61 of file cl_http.hpp.

Member Typedef Documentation

TResponse

using cl_http::ClHttp::TResponse = http_session_base::TResponse

Definition at line 71 of file cl_http.hpp.

Member Enumeration Documentation

kHttpRequestMethod

enum class cl_http::ClHttp::kHttpRequestMethod

strong

Enumerator
GET
POST
PUT

Definition at line 64 of file cl_http.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

ClHttp()

cl_http::ClHttp::ClHttp ( const std::string & server, const int & timeout = 1500 )

explicit

Definition at line 25 of file cl_http.cpp.

: initialized_{false},
  server_url_{server_name},
  connectionManager_{nullptr},
  sessionManager_{nullptr},
  requestExecutor_{nullptr}
{
  // Timeout parameter kept for API compatibility but unused (managed by components)
}

~ClHttp()

cl_http::ClHttp::~ClHttp ( )

virtual

Definition at line 35 of file cl_http.cpp.

{
  // Thread cleanup handled by CpHttpConnectionManager destructor
}

Member Function Documentation

onComponentInitialization()

template<typename TOrthogonal , typename TClient >

void cl_http::ClHttp::onComponentInitialization ( )

inline

Definition at line 81 of file cl_http.hpp.

  {
    // Create components
    connectionManager_ = this->createComponent<CpHttpConnectionManager, TOrthogonal, ClHttp>();
    sessionManager_ = this->createComponent<CpHttpSessionManager, TOrthogonal, ClHttp>();
    requestExecutor_ = this->createComponent<CpHttpRequestExecutor, TOrthogonal, ClHttp>();
 
    // Set component dependencies
    requestExecutor_->setDependencies(connectionManager_, sessionManager_);
 
    // Configure session manager with server URL
    sessionManager_->setServerUrl(server_url_);
  }

References connectionManager_, smacc2::ISmaccClient::createComponent(), requestExecutor_, server_url_, sessionManager_, cl_http::CpHttpRequestExecutor::setDependencies(), and cl_http::CpHttpSessionManager::setServerUrl().

Here is the call graph for this function:

onInitialize()

void cl_http::ClHttp::onInitialize ( )

overridevirtual

Reimplemented from smacc2::ISmaccClient.

Definition at line 40 of file cl_http.cpp.

{
  // Components created in onComponentInitialization()
  this->initialized_ = true;
}

References initialized_.

Member Data Documentation

connectionManager_

CpHttpConnectionManager* cl_http::ClHttp::connectionManager_

private

Definition at line 103 of file cl_http.hpp.

Referenced by onComponentInitialization().

HTTP_VERSION

const int cl_http::ClHttp::HTTP_VERSION = 11

private

Definition at line 96 of file cl_http.hpp.

initialized_

bool cl_http::ClHttp::initialized_

private

Definition at line 98 of file cl_http.hpp.

Referenced by onInitialize().

requestExecutor_

CpHttpRequestExecutor* cl_http::ClHttp::requestExecutor_

private

Definition at line 105 of file cl_http.hpp.

Referenced by onComponentInitialization().

server_url_

std::string cl_http::ClHttp::server_url_

private

Definition at line 100 of file cl_http.hpp.

Referenced by onComponentInitialization().

sessionManager_

CpHttpSessionManager* cl_http::ClHttp::sessionManager_

private

Definition at line 104 of file cl_http.hpp.

Referenced by onComponentInitialization().

---

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

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