Component that manages gcalcli connection health. More...

#include <cp_gcalcli_connection.hpp>

Inheritance diagram for cl_gcalcli::CpGcalcliConnection:

Collaboration diagram for cl_gcalcli::CpGcalcliConnection:

Public Member Functions
	CpGcalcliConnection ()

virtual	~CpGcalcliConnection ()=default

void	onInitialize () override

void	configure (const GcalcliConfig &config)
	Configure the gcalcli connection parameters.

ConnectionState	getConnectionState () const
	Get current connection state.

bool	isConnected () const
	Check if connected to Google Calendar.

bool	checkConnection ()
	Manually trigger a connection check.

void	restartConnection ()
	Restart connection after failure.

smacc2::client_core_components::SubprocessResult	executeGcalcli (const std::string &args, int timeout_ms=30000)
	Execute a gcalcli command.

const GcalcliConfig &	getConfig () const
	Get the gcalcli configuration.

template<typename T >
smacc2::SmaccSignalConnection	onConnectionLost (void(T::callback)(), T object)

template<typename T >
smacc2::SmaccSignalConnection	onConnectionRestored (void(T::callback)(), T object)

template<typename T >
smacc2::SmaccSignalConnection	onAuthenticationRequired (void(T::callback)(), T object)

template<typename TOrthogonal , typename TSourceObject >
void	onStateOrthogonalAllocation ()
	Template method for type-safe event posting setup.

Public Member Functions inherited from smacc2::ISmaccComponent
	ISmaccComponent ()

virtual	~ISmaccComponent ()

virtual std::string	getName () const

Public Member Functions inherited from smacc2::ISmaccUpdatable
	ISmaccUpdatable ()

	ISmaccUpdatable (rclcpp::Duration duration)

void	executeUpdate (rclcpp::Node::SharedPtr node)

void	setUpdatePeriod (rclcpp::Duration duration)

Public Attributes
smacc2::SmaccSignal< void()>	onConnectionLost_

smacc2::SmaccSignal< void()>	onConnectionRestored_

smacc2::SmaccSignal< void()>	onAuthenticationRequired_

std::function< void()>	postConnectionLostEvent_

std::function< void()>	postConnectionRestoredEvent_

std::function< void()>	postAuthenticationRequiredEvent_

Protected Member Functions
void	update () override
	Periodic update for heartbeat (called by SignalDetector)

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 Member Functions inherited from smacc2::ISmaccUpdatable

Private Member Functions
void	performHeartbeat ()
	Perform the heartbeat check.

void	handleConnectionStateChange (bool success, const std::string &output)
	Handle connection state change.

bool	isAuthenticationError (const std::string &output) const
	Check if output indicates authentication failure.

Private Attributes
GcalcliConfig	config_

ConnectionState	connection_state_

int	consecutive_failures_

bool	initialized_

std::chrono::steady_clock::time_point	last_heartbeat_time_

smacc2::client_core_components::CpSubprocessExecutor *	subprocess_executor_

std::mutex	state_mutex_

Additional Inherited Members
Protected Attributes inherited from smacc2::ISmaccComponent
ISmaccStateMachine *	stateMachine_

ISmaccClient *	owner_

Detailed Description

Component that manages gcalcli connection health.

This component monitors the connection to Google Calendar via gcalcli. It performs periodic heartbeat checks using "gcalcli list" and tracks consecutive failures. After max_consecutive_failures, it emits EvConnectionLost events.

The component uses CpSubprocessExecutor from smacc2 core for command execution.

Definition at line 42 of file cp_gcalcli_connection.hpp.

Constructor & Destructor Documentation

◆ CpGcalcliConnection()

cl_gcalcli::CpGcalcliConnection::CpGcalcliConnection ( )

Definition at line 20 of file cp_gcalcli_connection.cpp.

: connection_state_(ConnectionState::DISCONNECTED),
  consecutive_failures_(0),
  initialized_(false),
  subprocess_executor_(nullptr)
{
}

◆ ~CpGcalcliConnection()

virtual cl_gcalcli::CpGcalcliConnection::~CpGcalcliConnection ( )

virtualdefault

Member Function Documentation

◆ checkConnection()

bool cl_gcalcli::CpGcalcliConnection::checkConnection ( )

Manually trigger a connection check.

Returns: true if connection succeeded

Definition at line 69 of file cp_gcalcli_connection.cpp.

{
  if (!subprocess_executor_)
  {
    RCLCPP_ERROR(getLogger(), "[CpGcalcliConnection] Subprocess executor not available");
    return false;
  }
 
  // Use "gcalcli list" as a lightweight connection test
  auto result = executeGcalcli("list", 10000);
 
  bool success = (result.exit_code == 0 && !result.timed_out);
  handleConnectionStateChange(success, result.stdout_output);
 
  return success;
}

References executeGcalcli(), smacc2::ISmaccComponent::getLogger(), handleConnectionStateChange(), and subprocess_executor_.

Here is the call graph for this function:

◆ configure()

void cl_gcalcli::CpGcalcliConnection::configure ( const GcalcliConfig & config )

Configure the gcalcli connection parameters.

Definition at line 50 of file cp_gcalcli_connection.cpp.

{
  std::lock_guard<std::mutex> lock(state_mutex_);
  config_ = config;
  RCLCPP_DEBUG(getLogger(), "[CpGcalcliConnection] Configuration updated");
}

References config_, smacc2::ISmaccComponent::getLogger(), and state_mutex_.

Here is the call graph for this function:

◆ executeGcalcli()

smacc2::client_core_components::SubprocessResult cl_gcalcli::CpGcalcliConnection::executeGcalcli	(	const std::string &	args,
		int	timeout_ms = 30000 )

Execute a gcalcli command.

Parameters

args	Command arguments (e.g., "agenda --tsv")
timeout_ms	Command timeout in milliseconds

Returns: SubprocessResult with output and exit code

Definition at line 96 of file cp_gcalcli_connection.cpp.

{
  if (!subprocess_executor_)
  {
    smacc2::client_core_components::SubprocessResult error_result;
    error_result.exit_code = -1;
    error_result.stderr_output = "Subprocess executor not available";
    error_result.timed_out = false;
    return error_result;
  }
 
  // Build the full command
  std::string command = config_.gcalcli_path;
 
  // Add config folder if specified
  if (config_.config_folder.has_value())
  {
    command += " --config-folder \"" + config_.config_folder.value() + "\"";
  }
 
  // Add calendars if specified
  for (const auto & calendar : config_.calendars)
  {
    command += " --calendar \"" + calendar + "\"";
  }
 
  // Add the command arguments
  command += " " + args;
 
  RCLCPP_DEBUG(getLogger(), "[CpGcalcliConnection] Executing: %s", command.c_str());
 
  return subprocess_executor_->executeCommand(command, timeout_ms);
}

References cl_gcalcli::GcalcliConfig::calendars, config_, cl_gcalcli::GcalcliConfig::config_folder, smacc2::client_core_components::CpSubprocessExecutor::executeCommand(), smacc2::client_core_components::SubprocessResult::exit_code, cl_gcalcli::GcalcliConfig::gcalcli_path, smacc2::ISmaccComponent::getLogger(), smacc2::client_core_components::SubprocessResult::stderr_output, subprocess_executor_, and smacc2::client_core_components::SubprocessResult::timed_out.

Referenced by checkConnection(), cl_gcalcli::CbQuickAdd::onEntry(), performHeartbeat(), and cl_gcalcli::CpCalendarPoller::refreshAgenda().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConfig()

const GcalcliConfig & cl_gcalcli::CpGcalcliConnection::getConfig ( ) const

inline

Get the gcalcli configuration.

Definition at line 88 of file cp_gcalcli_connection.hpp.

88{ return config_; }

References config_.

Referenced by cl_gcalcli::CpCalendarPoller::refreshAgenda(), and cl_gcalcli::CpCalendarPoller::update().

Here is the caller graph for this function:

◆ getConnectionState()

ConnectionState cl_gcalcli::CpGcalcliConnection::getConnectionState ( ) const

Get current connection state.

Definition at line 57 of file cp_gcalcli_connection.cpp.

{
  std::lock_guard<std::mutex> lock(state_mutex_);
  return connection_state_;
}

References connection_state_, and state_mutex_.

◆ handleConnectionStateChange()

void cl_gcalcli::CpGcalcliConnection::handleConnectionStateChange	(	bool	success,
		const std::string &	output )

private

Handle connection state change.

Definition at line 158 of file cp_gcalcli_connection.cpp.

{
  std::lock_guard<std::mutex> lock(state_mutex_);
 
  ConnectionState previous_state = connection_state_;
 
  if (success)
  {
    consecutive_failures_ = 0;
 
    if (connection_state_ != ConnectionState::CONNECTED)
    {
      connection_state_ = ConnectionState::CONNECTED;
      RCLCPP_INFO(getLogger(), "[CpGcalcliConnection] Connection established");
 
      if (
        previous_state == ConnectionState::ERROR || previous_state == ConnectionState::DISCONNECTED)
      {
        onConnectionRestored_();
        if (postConnectionRestoredEvent_)
        {
          postConnectionRestoredEvent_();
        }
      }
    }
  }
  else
  {
    consecutive_failures_++;
 
    // Check if this is an authentication error
    if (isAuthenticationError(output))
    {
      connection_state_ = ConnectionState::AUTHENTICATING;
      RCLCPP_WARN(getLogger(), "[CpGcalcliConnection] Authentication required");
 
      onAuthenticationRequired_();
      if (postAuthenticationRequiredEvent_)
      {
        postAuthenticationRequiredEvent_();
      }
    }
    else if (consecutive_failures_ >= config_.max_consecutive_failures)
    {
      if (connection_state_ != ConnectionState::ERROR)
      {
        connection_state_ = ConnectionState::ERROR;
        RCLCPP_ERROR(
          getLogger(), "[CpGcalcliConnection] Connection lost after %d consecutive failures",
          consecutive_failures_);
 
        onConnectionLost_();
        if (postConnectionLostEvent_)
        {
          postConnectionLostEvent_();
        }
      }
    }
    else
    {
      RCLCPP_WARN(
        getLogger(), "[CpGcalcliConnection] Connection check failed (%d/%d)", consecutive_failures_,
        config_.max_consecutive_failures);
    }
  }
}

References cl_gcalcli::AUTHENTICATING, config_, cl_gcalcli::CONNECTED, connection_state_, consecutive_failures_, cl_gcalcli::DISCONNECTED, cl_gcalcli::ERROR, smacc2::ISmaccComponent::getLogger(), isAuthenticationError(), cl_gcalcli::GcalcliConfig::max_consecutive_failures, onAuthenticationRequired_, onConnectionLost_, onConnectionRestored_, postAuthenticationRequiredEvent_, postConnectionLostEvent_, postConnectionRestoredEvent_, and state_mutex_.

Referenced by checkConnection(), and performHeartbeat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAuthenticationError()

bool cl_gcalcli::CpGcalcliConnection::isAuthenticationError ( const std::string & output ) const

private

Check if output indicates authentication failure.

Definition at line 225 of file cp_gcalcli_connection.cpp.

{
  // Check for common gcalcli authentication error patterns
  return output.find("Authentication") != std::string::npos ||
         output.find("authorization") != std::string::npos ||
         output.find("oauth") != std::string::npos ||
         output.find("credentials") != std::string::npos ||
         output.find("token") != std::string::npos;
}

Referenced by handleConnectionStateChange().

Here is the caller graph for this function:

◆ isConnected()

bool cl_gcalcli::CpGcalcliConnection::isConnected ( ) const

Check if connected to Google Calendar.

Definition at line 63 of file cp_gcalcli_connection.cpp.

{
  std::lock_guard<std::mutex> lock(state_mutex_);
  return connection_state_ == ConnectionState::CONNECTED;
}

References cl_gcalcli::CONNECTED, connection_state_, and state_mutex_.

Referenced by cl_gcalcli::CpCalendarPoller::refreshAgenda(), and cl_gcalcli::CpCalendarPoller::update().

Here is the caller graph for this function:

◆ onAuthenticationRequired()

template<typename T >

smacc2::SmaccSignalConnection cl_gcalcli::CpGcalcliConnection::onAuthenticationRequired	(	void(T::*	callback )(),
		T *	object )

inline

Definition at line 109 of file cp_gcalcli_connection.hpp.

  {
    return this->getStateMachine()->createSignalConnection(
      onAuthenticationRequired_, callback, object);
  }

References smacc2::ISmaccStateMachine::createSignalConnection(), and smacc2::ISmaccComponent::getStateMachine().

Here is the call graph for this function:

◆ onConnectionLost()

template<typename T >

smacc2::SmaccSignalConnection cl_gcalcli::CpGcalcliConnection::onConnectionLost	(	void(T::*	callback )(),
		T *	object )

inline

Definition at line 97 of file cp_gcalcli_connection.hpp.

  {
    return this->getStateMachine()->createSignalConnection(onConnectionLost_, callback, object);
  }

References smacc2::ISmaccStateMachine::createSignalConnection(), and smacc2::ISmaccComponent::getStateMachine().

Referenced by cl_gcalcli::CbMonitorConnection::onEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onConnectionRestored()

template<typename T >

smacc2::SmaccSignalConnection cl_gcalcli::CpGcalcliConnection::onConnectionRestored	(	void(T::*	callback )(),
		T *	object )

inline

Definition at line 103 of file cp_gcalcli_connection.hpp.

  {
    return this->getStateMachine()->createSignalConnection(onConnectionRestored_, callback, object);
  }

References smacc2::ISmaccStateMachine::createSignalConnection(), and smacc2::ISmaccComponent::getStateMachine().

Referenced by cl_gcalcli::CbMonitorConnection::onEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onInitialize()

void cl_gcalcli::CpGcalcliConnection::onInitialize ( )

overridevirtual

Reimplemented from smacc2::ISmaccComponent.

Definition at line 28 of file cp_gcalcli_connection.cpp.

{
  if (!initialized_)
  {
    // Get the subprocess executor component
    requiresComponent(subprocess_executor_);
 
    if (subprocess_executor_ == nullptr)
    {
      RCLCPP_ERROR(getLogger(), "[CpGcalcliConnection] CpSubprocessExecutor component not found!");
      return;
    }
 
    last_heartbeat_time_ = std::chrono::steady_clock::now();
    initialized_ = true;
 
    RCLCPP_INFO(
      getLogger(), "[CpGcalcliConnection] Initialized with gcalcli path: %s",
      config_.gcalcli_path.c_str());
  }
}

References config_, cl_gcalcli::GcalcliConfig::gcalcli_path, smacc2::ISmaccComponent::getLogger(), initialized_, last_heartbeat_time_, smacc2::ISmaccComponent::requiresComponent(), and subprocess_executor_.

Here is the call graph for this function:

◆ onStateOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >

void cl_gcalcli::CpGcalcliConnection::onStateOrthogonalAllocation ( )

inline

Template method for type-safe event posting setup.

Definition at line 124 of file cp_gcalcli_connection.hpp.

  {
    postConnectionLostEvent_ = [this]()
    { this->postEvent<EvConnectionLost<CpGcalcliConnection, TOrthogonal>>(); };
 
    postConnectionRestoredEvent_ = [this]()
    { this->postEvent<EvConnectionRestored<CpGcalcliConnection, TOrthogonal>>(); };
 
    postAuthenticationRequiredEvent_ = [this]()
    { this->postEvent<EvAuthenticationRequired<CpGcalcliConnection, TOrthogonal>>(); };
  }

References postConnectionLostEvent_, and smacc2::ISmaccComponent::postEvent().

Here is the call graph for this function:

◆ performHeartbeat()

void cl_gcalcli::CpGcalcliConnection::performHeartbeat ( )

private

Perform the heartbeat check.

Definition at line 148 of file cp_gcalcli_connection.cpp.

{
  RCLCPP_DEBUG(getLogger(), "[CpGcalcliConnection] Performing heartbeat check...");
 
  auto result = executeGcalcli("list", 10000);
 
  bool success = (result.exit_code == 0 && !result.timed_out);
  handleConnectionStateChange(success, result.stdout_output);
}

References executeGcalcli(), smacc2::ISmaccComponent::getLogger(), and handleConnectionStateChange().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restartConnection()

void cl_gcalcli::CpGcalcliConnection::restartConnection ( )

Restart connection after failure.

Definition at line 86 of file cp_gcalcli_connection.cpp.

{
  std::lock_guard<std::mutex> lock(state_mutex_);
 
  RCLCPP_INFO(getLogger(), "[CpGcalcliConnection] Restarting connection...");
 
  consecutive_failures_ = 0;
  connection_state_ = ConnectionState::DISCONNECTED;
}

References connection_state_, consecutive_failures_, cl_gcalcli::DISCONNECTED, smacc2::ISmaccComponent::getLogger(), and state_mutex_.

Here is the call graph for this function:

◆ update()

void cl_gcalcli::CpGcalcliConnection::update ( )

overrideprotectedvirtual

Periodic update for heartbeat (called by SignalDetector)

Implements smacc2::ISmaccUpdatable.

Definition at line 131 of file cp_gcalcli_connection.cpp.

{
  if (!initialized_ || !subprocess_executor_)
  {
    return;
  }
 
  auto now = std::chrono::steady_clock::now();
  auto elapsed = std::chrono::duration_cast<std::chrono::seconds>(now - last_heartbeat_time_);
 
  if (elapsed >= config_.heartbeat_interval)
  {
    performHeartbeat();
    last_heartbeat_time_ = now;
  }
}

References config_, cl_gcalcli::GcalcliConfig::heartbeat_interval, initialized_, last_heartbeat_time_, performHeartbeat(), and subprocess_executor_.

Here is the call graph for this function:

Member Data Documentation

◆ config_

GcalcliConfig cl_gcalcli::CpGcalcliConnection::config_

private

Definition at line 158 of file cp_gcalcli_connection.hpp.

Referenced by configure(), executeGcalcli(), getConfig(), handleConnectionStateChange(), onInitialize(), and update().

◆ connection_state_

ConnectionState cl_gcalcli::CpGcalcliConnection::connection_state_

private

Definition at line 159 of file cp_gcalcli_connection.hpp.

Referenced by getConnectionState(), handleConnectionStateChange(), isConnected(), and restartConnection().

◆ consecutive_failures_

int cl_gcalcli::CpGcalcliConnection::consecutive_failures_

private

Definition at line 160 of file cp_gcalcli_connection.hpp.

Referenced by handleConnectionStateChange(), and restartConnection().

◆ initialized_

bool cl_gcalcli::CpGcalcliConnection::initialized_

private

Definition at line 161 of file cp_gcalcli_connection.hpp.

Referenced by onInitialize(), and update().

◆ last_heartbeat_time_

std::chrono::steady_clock::time_point cl_gcalcli::CpGcalcliConnection::last_heartbeat_time_

private

Definition at line 163 of file cp_gcalcli_connection.hpp.

Referenced by onInitialize(), and update().

◆ onAuthenticationRequired_

smacc2::SmaccSignal<void()> cl_gcalcli::CpGcalcliConnection::onAuthenticationRequired_

Definition at line 93 of file cp_gcalcli_connection.hpp.

Referenced by handleConnectionStateChange().

◆ onConnectionLost_

smacc2::SmaccSignal<void()> cl_gcalcli::CpGcalcliConnection::onConnectionLost_

Definition at line 91 of file cp_gcalcli_connection.hpp.

Referenced by handleConnectionStateChange().

◆ onConnectionRestored_

smacc2::SmaccSignal<void()> cl_gcalcli::CpGcalcliConnection::onConnectionRestored_

Definition at line 92 of file cp_gcalcli_connection.hpp.

Referenced by handleConnectionStateChange().

◆ postAuthenticationRequiredEvent_

std::function<void()> cl_gcalcli::CpGcalcliConnection::postAuthenticationRequiredEvent_

Definition at line 118 of file cp_gcalcli_connection.hpp.

Referenced by handleConnectionStateChange().

◆ postConnectionLostEvent_

std::function<void()> cl_gcalcli::CpGcalcliConnection::postConnectionLostEvent_

Definition at line 116 of file cp_gcalcli_connection.hpp.

Referenced by handleConnectionStateChange(), and onStateOrthogonalAllocation().

◆ postConnectionRestoredEvent_

std::function<void()> cl_gcalcli::CpGcalcliConnection::postConnectionRestoredEvent_

Definition at line 117 of file cp_gcalcli_connection.hpp.

Referenced by handleConnectionStateChange().

◆ state_mutex_

std::mutex cl_gcalcli::CpGcalcliConnection::state_mutex_

mutableprivate

Definition at line 166 of file cp_gcalcli_connection.hpp.

Referenced by configure(), getConnectionState(), handleConnectionStateChange(), isConnected(), and restartConnection().

◆ subprocess_executor_

smacc2::client_core_components::CpSubprocessExecutor* cl_gcalcli::CpGcalcliConnection::subprocess_executor_

private

Definition at line 165 of file cp_gcalcli_connection.hpp.

Referenced by checkConnection(), executeGcalcli(), onInitialize(), and update().

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

smacc2_client_library/cl_gcalcli/include/cl_gcalcli/components/cp_gcalcli_connection.hpp
smacc2_client_library/cl_gcalcli/src/cl_gcalcli/components/cp_gcalcli_connection.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CpGcalcliConnection()

◆ ~CpGcalcliConnection()

Member Function Documentation

◆ checkConnection()

◆ configure()

◆ executeGcalcli()

◆ getConfig()

◆ getConnectionState()

◆ handleConnectionStateChange()

◆ isAuthenticationError()

◆ isConnected()

◆ onAuthenticationRequired()

◆ onConnectionLost()

◆ onConnectionRestored()

◆ onInitialize()

◆ onStateOrthogonalAllocation()

◆ performHeartbeat()

◆ restartConnection()

◆ update()

Member Data Documentation

◆ config_

◆ connection_state_

◆ consecutive_failures_

◆ initialized_

◆ last_heartbeat_time_

◆ onAuthenticationRequired_

◆ onConnectionLost_

◆ onConnectionRestored_

◆ postAuthenticationRequiredEvent_

◆ postConnectionLostEvent_

◆ postConnectionRestoredEvent_

◆ state_mutex_

◆ subprocess_executor_