ros2/openvehicle-api
3
0
Fork 0
mirror of https://github.com/eclipse-openvehicle-api/openvehicle-api.git synced 2026-07-01 21:25:11 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Update sdv_packager (#6)

Browse Source
This commit is contained in:
tompzf
2026-03-27 14:12:49 +01:00
committed by GitHub
parent 234be8917f
commit aefefd52f7
717 changed files with 42252 additions and 11334 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
sdv_services/ipc_connect/CMakeLists.txt
View File

@@ -1,3 +1,16 @@
#*******************************************************************************
# Copyright (c) 2025-2026 ZF Friedrichshafen AG
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
#
# Contributors:
# Erik Verhoeven - initial API and implementation
#*******************************************************************************
# Include cross-compilation toolchain file
include(../../cross-compile-tools.cmake)

49
sdv_services/ipc_connect/client.cpp
View File

@@ -1,3 +1,16 @@
/********************************************************************************
* Copyright (c) 2025-2026 ZF Friedrichshafen AG
*
* This program and the accompanying materials are made available under the
* terms of the Apache License Version 2.0 which is available at
* https://www.apache.org/licenses/LICENSE-2.0
*
* SPDX-License-Identifier: Apache-2.0
*
* Contributors:
* Erik Verhoeven - initial API and implementation
********************************************************************************/
#include "client.h"
#include <support/toml.h>
#include <interfaces/com.h>
@@ -16,37 +29,13 @@ void CRepositoryProxy::DestroyObject()
m_rClient.Disconnect(m_tConnection);
}
void CClient::Initialize(const sdv::u8string& /*ssObjectConfig*/)
bool CClient::OnInitialize()
{
m_eObjectStatus = sdv::EObjectStatus::initialized;
return true;
}
sdv::EObjectStatus CClient::GetStatus() const
void CClient::OnShutdown()
{
return m_eObjectStatus;
}
void CClient::SetOperationMode(sdv::EOperationMode eMode)
{
switch (eMode)
{
case sdv::EOperationMode::configuring:
if (m_eObjectStatus == sdv::EObjectStatus::running || m_eObjectStatus == sdv::EObjectStatus::initialized)
m_eObjectStatus = sdv::EObjectStatus::configuring;
break;
case sdv::EOperationMode::running:
if (m_eObjectStatus == sdv::EObjectStatus::configuring || m_eObjectStatus == sdv::EObjectStatus::initialized)
m_eObjectStatus = sdv::EObjectStatus::running;
break;
default:
break;
}
}
void CClient::Shutdown()
{
m_eObjectStatus = sdv::EObjectStatus::shutdown_in_progress;
sdv::com::IConnectionControl* pConnectionControl = sdv::core::GetObject<sdv::com::IConnectionControl>("CommunicationControl");
if (!pConnectionControl)
SDV_LOG_ERROR("Failed to get communication control!");
@@ -60,8 +49,6 @@ void CClient::Shutdown()
for (const auto& rvtRepository : mapRepositoryProxiesCopy)
pConnectionControl->RemoveConnection(rvtRepository.first);
}
m_eObjectStatus = sdv::EObjectStatus::destruction_pending;
}
sdv::IInterfaceAccess* CClient::Connect(const sdv::u8string& ssConnectString)
@@ -126,14 +113,14 @@ Port = ")code" + std::to_string(uiPort) + R"code(
else
{
SDV_LOG_ERROR("Invalid or missing listener configuration for listener service!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
SetObjectIntoConfigErrorState();
return nullptr;
}
}
catch (const sdv::toml::XTOMLParseException& rexcept)
{
SDV_LOG_ERROR("Invalid service configuration for listener service: ", rexcept.what(), "!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
SetObjectIntoConfigErrorState();
return nullptr;
}

43
sdv_services/ipc_connect/client.h
View File

@@ -1,3 +1,16 @@
/********************************************************************************
* Copyright (c) 2025-2026 ZF Friedrichshafen AG
*
* This program and the accompanying materials are made available under the
* terms of the Apache License Version 2.0 which is available at
* https://www.apache.org/licenses/LICENSE-2.0
*
* SPDX-License-Identifier: Apache-2.0
*
* Contributors:
* Erik Verhoeven - initial API and implementation
********************************************************************************/
#ifndef CLIENT_H
#define CLIENT_H
@@ -55,42 +68,29 @@ private:
/**
* @brief Client object
*/
class CClient : public sdv::CSdvObject, public sdv::IObjectControl, public sdv::com::IClientConnect
class CClient : public sdv::CSdvObject, public sdv::com::IClientConnect
{
public:
// Interface map
BEGIN_SDV_INTERFACE_MAP()
SDV_INTERFACE_ENTRY(sdv::IObjectControl)
SDV_INTERFACE_ENTRY(sdv::com::IClientConnect)
END_SDV_INTERFACE_MAP()
// Object declaration
DECLARE_OBJECT_CLASS_TYPE(sdv::EObjectType::SystemObject)
DECLARE_OBJECT_CLASS_TYPE(sdv::EObjectType::system_object)
DECLARE_OBJECT_CLASS_NAME("ConnectionService")
DECLARE_OBJECT_SINGLETON()
/**
* @brief Initialize the object. Overload of sdv::IObjectControl::Initialize.
* @param[in] ssObjectConfig Optional configuration string.
*/
void Initialize(const sdv::u8string& ssObjectConfig) override;
/**
* @brief Get the current status of the object. Overload of sdv::IObjectControl::GetStatus.
* @return Return the current status of the object.
*/
sdv::EObjectStatus GetStatus() const override;
/**
* @brief Set the component operation mode. Overload of sdv::IObjectControl::SetOperationMode.
* @param[in] eMode The operation mode, the component should run in.
* @brief Initialization event, called after object configuration was loaded. Overload of sdv::CSdvObject::OnInitialize.
* @return Returns 'true' when the initialization was successful, 'false' when not.
*/
void SetOperationMode(sdv::EOperationMode eMode) override;
virtual bool OnInitialize() override;
/**
* @brief Shutdown called before the object is destroyed. Overload of sdv::IObjectControl::Shutdown.
*/
void Shutdown() override;
* @brief Shutdown the object. Overload of sdv::CSdvObject::OnShutdown.
*/
virtual void OnShutdown() override;
/**
* @brief Connect to a remote system using the connection string to contact the system. Overload of
@@ -122,7 +122,6 @@ public:
void Disconnect(sdv::com::TConnectionID tConnectionID);
private:
sdv::EObjectStatus m_eObjectStatus = sdv::EObjectStatus::initialization_pending; ///< Object status.
std::mutex m_mtxRepositoryProxies; ///< Protect access to the remnote repository map.
std::map<sdv::com::TConnectionID, CRepositoryProxy> m_mapRepositoryProxies; ///< map of remote repositories.
};

143
sdv_services/ipc_connect/listener.cpp
View File

@@ -1,3 +1,16 @@
/********************************************************************************
* Copyright (c) 2025-2026 ZF Friedrichshafen AG
*
* This program and the accompanying materials are made available under the
* terms of the Apache License Version 2.0 which is available at
* https://www.apache.org/licenses/LICENSE-2.0
*
* SPDX-License-Identifier: Apache-2.0
*
* Contributors:
* Erik Verhoeven - initial API and implementation
********************************************************************************/
#include "listener.h"
#include <support/toml.h>
#include <interfaces/com.h>
@@ -65,84 +78,63 @@ sdv::u8string CChannelBroker::RequestChannel(/*in*/ const sdv::u8string& /*ssCon
CListener::CListener() : m_broker(*this)
{}
void CListener::Initialize(const sdv::u8string& ssObjectConfig)
bool CListener::OnInitialize()
{
const sdv::app::IAppContext* pContext = sdv::core::GetCore<sdv::app::IAppContext>();
if (!pContext)
{
SDV_LOG_ERROR("Failed to get application context!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
return false;
}
sdv::com::IConnectionControl* pConnectionControl = sdv::core::GetObject<sdv::com::IConnectionControl>("CommunicationControl");
if (!pConnectionControl)
{
SDV_LOG_ERROR("Failed to get communication control!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
return false;
}
sdv::ipc::ICreateEndpoint* pEndpoint = nullptr;
std::string ssConfig;
try
if (m_ssType == "Local")
{
// Determine whether the service is running as server or as client.
sdv::toml::CTOMLParser config(ssObjectConfig);
std::string ssType = config.GetDirect("Listener.Type").GetValue();
if (ssType == "Local")
m_bLocalListener = true;
pEndpoint = sdv::core::GetObject<sdv::ipc::ICreateEndpoint>("LocalChannelControl");
if (!pEndpoint)
{
uint32_t uiInstanceID = config.GetDirect("Listener.Instance").GetValue();
m_bLocalListener = true;
pEndpoint = sdv::core::GetObject<sdv::ipc::ICreateEndpoint>("LocalChannelControl");
if (!pEndpoint)
{
SDV_LOG_ERROR("No local channel control!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
}
SDV_LOG_ERROR("No local channel control!");
return false;
}
// Request the instance ID from the app control
ssConfig = std::string(R"code([IpcChannel]
Name = "LISTENER_)code") + std::to_string(uiInstanceID ? uiInstanceID : pContext->GetInstanceID()) + R"code("
// Request the instance ID from the app control
ssConfig = std::string(R"code([IpcChannel]
Name = "LISTENER_)code") + std::to_string(m_uiInstanceID ? m_uiInstanceID : pContext->GetInstanceID()) + R"code("
Size = 2048
)code";
}
else if (ssType == "Remote")
{
m_bLocalListener = false;
std::string ssInterface = config.GetDirect("Listener.Interface").GetValue();
uint32_t uiPort = config.GetDirect("Listener.Interface").GetValue();
if (ssInterface.empty() || !uiPort)
{
SDV_LOG_ERROR("Missing interface or port number to initialize a remote listener!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
}
pEndpoint = sdv::core::GetObject<sdv::ipc::ICreateEndpoint>("RemoteChannelControl");
if (!pEndpoint)
{
SDV_LOG_ERROR("No remote channel control!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
}
ssConfig = R"code([IpcChannel]
Interface = ")code" + ssInterface + R"code(
Port = ")code" + std::to_string(uiPort) + R"code(
)code";
}
else
{
SDV_LOG_ERROR("Invalid or missing listener configuration for listener service!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
}
}
catch (const sdv::toml::XTOMLParseException& rexcept)
else if (m_ssType == "Remote")
{
SDV_LOG_ERROR("Invalid service configuration for listener service: ", rexcept.what(), "!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
m_bLocalListener = false;
if (m_ssInterface.empty() || !m_uiPort)
{
SDV_LOG_ERROR("Missing interface or port number to initialize a remote listener!");
return false;
}
pEndpoint = sdv::core::GetObject<sdv::ipc::ICreateEndpoint>("RemoteChannelControl");
if (!pEndpoint)
{
SDV_LOG_ERROR("No remote channel control!");
return false;
}
ssConfig = R"code([IpcChannel]
Interface = ")code" + m_ssInterface + R"code(
Port = ")code" + std::to_string(m_uiPort) + R"code(
)code";
}
else
{
SDV_LOG_ERROR("Invalid or missing listener configuration for listener service!");
return false;
}
// Create the endpoint
@@ -150,8 +142,7 @@ Port = ")code" + std::to_string(uiPort) + R"code(
if (!sEndpoint.pConnection)
{
SDV_LOG_ERROR("Could not create the endpoint for listener service!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
return false;
}
sdv::TObjectPtr ptrEndpoint(sEndpoint.pConnection); // Does automatic destruction if failure happens.
@@ -161,39 +152,13 @@ Port = ")code" + std::to_string(uiPort) + R"code(
if (!m_tConnection)
{
SDV_LOG_ERROR("Could not assign the server endpoint!");
m_eObjectStatus = sdv::EObjectStatus::initialization_failure;
return;
return false;
}
m_eObjectStatus = sdv::EObjectStatus::initialized;
return true;
}
sdv::EObjectStatus CListener::GetStatus() const
void CListener::OnShutdown()
{
return m_eObjectStatus;
}
void CListener::SetOperationMode(sdv::EOperationMode eMode)
{
switch (eMode)
{
case sdv::EOperationMode::configuring:
if (m_eObjectStatus == sdv::EObjectStatus::running || m_eObjectStatus == sdv::EObjectStatus::initialized)
m_eObjectStatus = sdv::EObjectStatus::configuring;
break;
case sdv::EOperationMode::running:
if (m_eObjectStatus == sdv::EObjectStatus::configuring || m_eObjectStatus == sdv::EObjectStatus::initialized)
m_eObjectStatus = sdv::EObjectStatus::running;
break;
default:
break;
}
}
void CListener::Shutdown()
{
m_eObjectStatus = sdv::EObjectStatus::shutdown_in_progress;
// Shutdown the listener...
if (m_tConnection != sdv::com::TConnectionID{})
{
@@ -206,8 +171,6 @@ void CListener::Shutdown()
}
m_ptrConnection.Clear();
m_eObjectStatus = sdv::EObjectStatus::destruction_pending;
}
bool CListener::IsLocalListener() const

59
sdv_services/ipc_connect/listener.h
View File

@@ -1,3 +1,16 @@
/********************************************************************************
* Copyright (c) 2025-2026 ZF Friedrichshafen AG
*
* This program and the accompanying materials are made available under the
* terms of the Apache License Version 2.0 which is available at
* https://www.apache.org/licenses/LICENSE-2.0
*
* SPDX-License-Identifier: Apache-2.0
*
* Contributors:
* Erik Verhoeven - initial API and implementation
********************************************************************************/
#ifndef LISTENER_H
#define LISTENER_H
@@ -40,7 +53,7 @@ private:
/**
* @brief Listener object
*/
class CListener : public sdv::CSdvObject, public sdv::IObjectControl
class CListener : public sdv::CSdvObject
{
public:
/**
@@ -48,17 +61,22 @@ public:
*/
CListener();
// Interface map
BEGIN_SDV_INTERFACE_MAP()
SDV_INTERFACE_ENTRY(sdv::IObjectControl)
END_SDV_INTERFACE_MAP()
// Object declaration
DECLARE_OBJECT_CLASS_TYPE(sdv::EObjectType::SystemObject)
DECLARE_OBJECT_CLASS_TYPE(sdv::EObjectType::system_object)
DECLARE_OBJECT_CLASS_NAME("ConnectionListenerService")
// Parameter map
BEGIN_SDV_PARAM_MAP()
SDV_PARAM_ENABLE_LOCKING()
SDV_PARAM_GROUP("Listener")
SDV_PARAM_ENTRY(m_ssType, "Type", "Local", "", "The type of listener \"Local\" or \"Remote\".")
SDV_PARAM_ENTRY(m_uiInstanceID, "Instance", 0, "", "The instance ID to listen for.")
SDV_PARAM_ENTRY(m_ssInterface, "Interface", "", "", "Interface identification.")
SDV_PARAM_ENTRY(m_uiPort, "Port", 0, "", "Port number for connection.")
END_SDV_PARAM_MAP()
/**
* @brief Initialize the object. Overload of sdv::IObjectControl::Initialize.
* @brief Initialization event, called after object configuration was loaded. Overload of sdv::CSdvObject::OnInitialize.
* @details The object configuration contains the information needed to start the listener. The following configuration is
* available for the local listener:
* @code
@@ -73,26 +91,14 @@ public:
* Interface = "127.0.0.1"
* Port = 2000
* @endcode
* @param[in] ssObjectConfig Optional configuration string.
* @return Returns 'true' when the initialization was successful, 'false' when not.
*/
void Initialize(const sdv::u8string& ssObjectConfig) override;
virtual bool OnInitialize() override;
/**
* @brief Get the current status of the object. Overload of sdv::IObjectControl::GetStatus.
* @return Return the current status of the object.
* @brief Shutdown the object. Overload of sdv::CSdvObject::OnShutdown.
*/
sdv::EObjectStatus GetStatus() const override;
/**
* @brief Set the component operation mode. Overload of sdv::IObjectControl::SetOperationMode.
* @param[in] eMode The operation mode, the component should run in.
*/
void SetOperationMode(sdv::EOperationMode eMode) override;
/**
* @brief Shutdown called before the object is destroyed. Overload of sdv::IObjectControl::Shutdown.
*/
void Shutdown() override;
virtual void OnShutdown() override;
/**
* @brief When set, the listener is configured to be a local listener. Otherwise the listerner is configured as remote listener.
@@ -101,7 +107,10 @@ public:
bool IsLocalListener() const;
private:
sdv::EObjectStatus m_eObjectStatus = sdv::EObjectStatus::initialization_pending; ///< To update the object status when it changes.
sdv::u8string m_ssType; ///< Listener type: "Local" or "Remote"
uint32_t m_uiInstanceID = 0; ///< Instance ID to listen for.
std::string m_ssInterface; ///< Interface string for remote listener.
uint32_t m_uiPort = 0; ///< Port for remote listener.
sdv::TObjectPtr m_ptrConnection; ///< The connection object.
CChannelBroker m_broker; ///< Channel broker, used to request new channels
bool m_bLocalListener = true; ///< When set, the listener is a local listener; otherwise a remote listener.