diag::client::conversation_manager::ConversationManager Class Reference

Class to manage all the conversation created from usr request. More...

#include <conversation_manager.h>

Collaboration diagram for diag::client::conversation_manager::ConversationManager:

Classes
struct	ConversationStorage
	Store Dm conversation. More...

Public Member Functions
	ConversationManager (diag::client::config_parser::DcmClientConfig config, diag::client::uds_transport::UdsTransportProtocolManager &uds_transport_mgr) noexcept
	Constructs an instance of ConversationManager. More...
	~ConversationManager () noexcept=default
	Destructs an instance of ConversationManager. More...
void	Startup () noexcept
	Function to start the ConversationManager. More...
void	Shutdown () noexcept
	Function to shutdown the ConversationManager. More...
diag::client::conversation::Conversation &	GetDiagnosticClientConversation (std::string_view conversation_name) noexcept
	Function to get DM conversation object based on conversation name. More...

Private Member Functions
void	StoreConversationConfig (diag::client::config_parser::DcmClientConfig &config) noexcept
	Function to store the dcm client configuration internally. More...

Private Attributes
uds_transport::UdsTransportProtocolManager &	uds_transport_mgr_
	Store the reference to uds transport manager. More...
std::unordered_map< std::string, ConversationStorage >	conversation_map_
	Map to store conversation object(dm) along with conversation name. More...

Detailed Description

Class to manage all the conversation created from usr request.

Definition at line 29 of file conversation_manager.h.

Constructor & Destructor Documentation

ConversationManager()

diag::client::conversation_manager::ConversationManager::ConversationManager ( diag::client::config_parser::DcmClientConfig  config, diag::client::uds_transport::UdsTransportProtocolManager &  uds_transport_mgr  )

noexcept

Constructs an instance of ConversationManager.

Parameters

[in]	config	The configuration of dcm client
[in]	uds_transport_mgr	The reference to Uds transport manger

Definition at line 31 of file conversation_manager.cpp.

    : uds_transport_mgr_{uds_transport_mgr} {
  // store the conversation config (vd & dm) out of passed config
  StoreConversationConfig(config);
}

~ConversationManager()

diag::client::conversation_manager::ConversationManager::~ConversationManager ( )

defaultnoexcept

Destructs an instance of ConversationManager.

Member Function Documentation

GetDiagnosticClientConversation()

diag::client::conversation::Conversation & diag::client::conversation_manager::ConversationManager::GetDiagnosticClientConversation ( std::string_view  conversation_name )

noexcept

Function to get DM conversation object based on conversation name.

Parameters

[in]

conversation_name

The conversation name

Returns

The reference to diag client conversation as per provided conversation name

Definition at line 61 of file conversation_manager.cpp.

                                               {
  // find the conversation from config stored
  auto it = conversation_map_.find(std::string{conversation_name});
  if (it != conversation_map_.end()) {
    std::string const conversation_name_in_map{it->first};
    it->second.conversation =
        std::visit(core_type::visit::overloaded{
                       [this, &conversation_name_in_map](
                           conversation::DMConversationType conversation_type) noexcept {
                         // Create the conversation
                         std::unique_ptr<diag::client::conversation::Conversation> conversation{
                             std::make_unique<diag::client::conversation::DmConversation>(
                                 conversation_name_in_map, conversation_type)};
                         // Register the connection
                         conversation->RegisterConnection(
                             uds_transport_mgr_.GetTransportProtocolHandler().CreateTcpConnection(
                                 conversation->GetConversationHandler(),
                                 conversation_type.tcp_address, conversation_type.port_num));
                         return conversation;
                       },
                       [this, &conversation_name_in_map](
                           conversation::VDConversationType conversation_type) noexcept {
                         // Create the conversation
                         std::unique_ptr<diag::client::conversation::Conversation> conversation{
                             std::make_unique<diag::client::conversation::VdConversation>(
                                 conversation_name_in_map, conversation_type)};
                         // Register the connection
                         conversation->RegisterConnection(
                             uds_transport_mgr_.GetTransportProtocolHandler().CreateUdpConnection(
                                 conversation->GetConversationHandler(),
                                 conversation_type.udp_address, conversation_type.port_num));
                         return conversation;
                       }},
                   it->second.conversation_type);
  } else {
    logger::DiagClientLogger::GetDiagClientLogger().GetLogger().LogFatalAndTerminate(
        FILE_NAME, __LINE__, __func__, [conversation_name](std::stringstream &msg) {
          msg << "Invalid conversation name: '" << conversation_name
              << "', provide correct name as per config file";
        });
  }
  return *(it->second.conversation);
}

References FILE_NAME, and diag::client::logger::DiagClientLogger::GetDiagClientLogger().

Here is the call graph for this function:

Shutdown()

void diag::client::conversation_manager::ConversationManager::Shutdown ( )

noexcept

Function to shutdown the ConversationManager.

Definition at line 41 of file conversation_manager.cpp.

                                            {
  // Loop through available conversation and check if already in shutdown state
  for (std::unordered_map<std::string, ConversationStorage>::value_type const &conversation:
       conversation_map_) {
    if (conversation.second.conversation != nullptr) {
      if (conversation.second.conversation->GetActivityStatus() !=
          conversation::Conversation::ActivityStatusType::kInactive) {
        // Shutdown is not called on the conversation by user, log warning and perform shutdown
        logger::DiagClientLogger::GetDiagClientLogger().GetLogger().LogWarn(
            FILE_NAME, __LINE__, "", [&conversation](std::stringstream &msg) {
              msg << "'" << conversation.first << "'"
                  << "-> "
                  << "Shutdown is not triggered by user, will be shutdown forcefully";
            });
        conversation.second.conversation->Shutdown();
      }
    }
  }
}

References conversation_map_, FILE_NAME, diag::client::logger::DiagClientLogger::GetDiagClientLogger(), and diag::client::conversation::Conversation::kInactive.

Referenced by diag::client::dcm::DCMClient::Shutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

Startup()

void diag::client::conversation_manager::ConversationManager::Startup ( )

noexcept

Function to start the ConversationManager.

Definition at line 39 of file conversation_manager.cpp.

{}

StoreConversationConfig()

void diag::client::conversation_manager::ConversationManager::StoreConversationConfig ( diag::client::config_parser::DcmClientConfig &  config )

privatenoexcept

Function to store the dcm client configuration internally.

Parameters

[in]

config

The Dcm client configuration

Definition at line 106 of file conversation_manager.cpp.

                                                             {
  {  // Create Vehicle discovery config
    conversation::VDConversationType conversion_identifier{};
    conversion_identifier.udp_address = config.udp_ip_address;
    conversion_identifier.udp_broadcast_address = config.udp_broadcast_address;
    conversion_identifier.port_num = kRandomPortNumber;  // random selection of port number
    conversation_map_.emplace(kVdConversationName,
                              ConversationStorage{conversion_identifier, nullptr});
  }
 
  {  // Create Conversation config
    for (std::uint8_t conv_count{0U}; conv_count < config.num_of_conversation; conv_count++) {
      conversation::DMConversationType conversion_identifier{};
      conversion_identifier.rx_buffer_size = config.conversations[conv_count].rx_buffer_size;
      conversion_identifier.p2_client_max = config.conversations[conv_count].p2_client_max;
      conversion_identifier.p2_star_client_max =
          config.conversations[conv_count].p2_star_client_max;
      conversion_identifier.source_address = config.conversations[conv_count].source_address;
      conversion_identifier.tcp_address = config.conversations[conv_count].network.tcp_ip_address;
      conversion_identifier.port_num = kRandomPortNumber;  // random selection of port number
      conversation_map_.emplace(config.conversations[conv_count].conversation_name,
                                ConversationStorage{conversion_identifier, nullptr});
    }
  }
}

References diag::client::conversation_manager::anonymous_namespace{conversation_manager.cpp}::kRandomPortNumber, diag::client::conversation_manager::anonymous_namespace{conversation_manager.cpp}::kVdConversationName, diag::client::conversation::DMConversationType::rx_buffer_size, and diag::client::conversation::VDConversationType::udp_address.

Member Data Documentation

conversation_map_

std::unordered_map<std::string, ConversationStorage> diag::client::conversation_manager::ConversationManager::conversation_map_

private

Map to store conversation object(dm) along with conversation name.

Pair of Conversation name and Conversation Object

Definition at line 92 of file conversation_manager.h.

Referenced by Shutdown().

uds_transport_mgr_

uds_transport::UdsTransportProtocolManager& diag::client::conversation_manager::ConversationManager::uds_transport_mgr_

private

Store the reference to uds transport manager.

Definition at line 86 of file conversation_manager.h.

---

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

• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/appl/src/diag-client/dcm/conversation/conversation_manager.h
• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/appl/src/diag-client/dcm/conversation/conversation_manager.cpp