mirror of
https://github.com/eclipse-openvehicle-api/openvehicle-api.git
synced 2026-04-15 17:48:16 +00:00
tunnel component & update vehicle abstraction example (#8)
This commit is contained in:
140
sdv_services/uds_unix_tunnel/channel_mgnt.h
Normal file
140
sdv_services/uds_unix_tunnel/channel_mgnt.h
Normal file
@@ -0,0 +1,140 @@
|
||||
/********************************************************************************
|
||||
* 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:
|
||||
* Denisa Ros - initial API and implementation
|
||||
********************************************************************************/
|
||||
#if defined(__unix__)
|
||||
#ifndef UNIX_TUNNEL_CHANNEL_MGNT_H
|
||||
#define UNIX_TUNNEL_CHANNEL_MGNT_H
|
||||
|
||||
#include <support/component_impl.h>
|
||||
#include <interfaces/ipc.h>
|
||||
#include "../sdv_services/uds_unix_sockets/channel_mgnt.h" // existing UDS transport
|
||||
|
||||
class CUnixTunnelConnection;
|
||||
/**
|
||||
* @brief Initialize WinSock on Windows (idempotent).
|
||||
*
|
||||
* This helper ensures WSAStartup() is called only once in the process.
|
||||
* On non-Windows platforms, this is a no-op and always returns success.
|
||||
*
|
||||
* @return 0 on success, otherwise a WinSock error code (Windows only).
|
||||
*/
|
||||
inline int StartUpWinSock()
|
||||
{
|
||||
#ifdef _WIN32
|
||||
static bool isInitialized = false;
|
||||
if (isInitialized)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
WSADATA wsaData {};
|
||||
const int error = WSAStartup(MAKEWORD(2, 2), &wsaData);
|
||||
if (error != 0)
|
||||
{
|
||||
SDV_LOG_ERROR("WSAStartup failed with error: ", std::to_string(error));
|
||||
}
|
||||
else
|
||||
{
|
||||
SDV_LOG_INFO("WSAStartup initialized");
|
||||
isInitialized = true;
|
||||
}
|
||||
return error;
|
||||
#else
|
||||
// Non-Windows: nothing to do. Return success for symmetry
|
||||
return 0;
|
||||
#endif
|
||||
}
|
||||
/**
|
||||
* @class CUnixTunnelChannelMgnt
|
||||
* @brief IPC channel management class for Unix Domain Socket tunnel communication.
|
||||
*
|
||||
* This manager exposes the "tunnel" IPC type, similar to UDS, with channel multiplexing planned.
|
||||
* It provides creation and access to tunnel endpoints, manages server-side tunnel lifetimes,
|
||||
* and integrates with the SDV object/component framework.
|
||||
*/
|
||||
class CUnixTunnelChannelMgnt :
|
||||
public sdv::CSdvObject,
|
||||
public sdv::ipc::ICreateEndpoint,
|
||||
public sdv::ipc::IChannelAccess
|
||||
{
|
||||
public:
|
||||
// Interface map
|
||||
BEGIN_SDV_INTERFACE_MAP()
|
||||
SDV_INTERFACE_ENTRY(sdv::ipc::IChannelAccess)
|
||||
SDV_INTERFACE_ENTRY(sdv::ipc::ICreateEndpoint)
|
||||
END_SDV_INTERFACE_MAP()
|
||||
|
||||
// Object declarations
|
||||
DECLARE_OBJECT_CLASS_TYPE(sdv::EObjectType::system_object)
|
||||
DECLARE_OBJECT_CLASS_NAME("UnixTunnelChannelControl")
|
||||
DECLARE_OBJECT_CLASS_ALIAS("TunnelChannelControl")
|
||||
DECLARE_DEFAULT_OBJECT_NAME("TunnelChannelControl")
|
||||
DECLARE_OBJECT_SINGLETON()
|
||||
|
||||
/**
|
||||
* @brief Destructor for CUnixTunnelChannelMgnt.
|
||||
*/
|
||||
virtual ~CUnixTunnelChannelMgnt() = default;
|
||||
|
||||
/**
|
||||
* @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.
|
||||
*/
|
||||
virtual bool OnInitialize() override;
|
||||
|
||||
/**
|
||||
* @brief Shutdown the object. Overload of sdv::CSdvObject::OnShutdown.
|
||||
*/
|
||||
virtual void OnShutdown() override;
|
||||
|
||||
/**
|
||||
* @brief Creates a tunnel endpoint (server side) and returns endpoint info.
|
||||
*
|
||||
* Optionally uses a TOML config string for custom endpoint parameters.
|
||||
*
|
||||
* @param ssChannelConfig Optional config string (TOML).
|
||||
* @return The channel endpoint structure.
|
||||
*/
|
||||
sdv::ipc::SChannelEndpoint CreateEndpoint(const sdv::u8string& ssChannelConfig) override;
|
||||
|
||||
/**
|
||||
* @brief Creates or accesses a connection object from the channel connect string.
|
||||
*
|
||||
* Parses the connect string and returns a pointer to the appropriate connection access interface.
|
||||
*
|
||||
* @param ssConnectString The channel connect string.
|
||||
* @return Pointer to connection access interface.
|
||||
*/
|
||||
sdv::IInterfaceAccess* Access(const sdv::u8string& ssConnectString) override;
|
||||
|
||||
private:
|
||||
/**
|
||||
* @brief Helper: chooses runtime dir (/run/user/<uid>/sdv) or fallback (/tmp/sdv).
|
||||
*
|
||||
* Used for determining the directory path for runtime sockets.
|
||||
*
|
||||
* @return Directory path for runtime sockets.
|
||||
*/
|
||||
static std::string MakeUserRuntimeDir();
|
||||
|
||||
/**
|
||||
* @brief Keeps server-side tunnel connections alive for the lifetime of the manager.
|
||||
*
|
||||
* This ensures that server tunnel objects are not destroyed while the manager is active.
|
||||
*/
|
||||
std::vector<std::shared_ptr<CUnixTunnelConnection>> m_ServerTunnels;
|
||||
};
|
||||
|
||||
DEFINE_SDV_OBJECT(CUnixTunnelChannelMgnt)
|
||||
|
||||
#endif // UNIX_TUNNEL_CHANNEL_MGNT_H
|
||||
#endif // defined(__unix__)
|
||||
Reference in New Issue
Block a user