ros2/openvehicle-api
3
0
Fork 0
mirror of https://github.com/eclipse-openvehicle-api/openvehicle-api.git synced 2026-04-12 08:30:24 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

tunnel component & update vehicle abstraction example (#8)

Browse Source
This commit is contained in:
tompzf
2026-04-02 17:37:00 +02:00
committed by GitHub
parent 6ed5fdb951
commit 07cf4f654b
94 changed files with 9268 additions and 830 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
export/interfaces/ipc.idl
View File

@@ -72,9 +72,9 @@ module sdv
};
/**
* @brief Connection status enumeration
* @brief Connection state enumeration
*/
enum EConnectStatus : uint32
enum EConnectState : uint32
{
uninitialized = 0, ///< Initialization via IConnect pending/required
initializing = 1, ///< Initiation channel access.
@@ -96,8 +96,8 @@ module sdv
{
/**
* @brief Establish a connection and start sending/receiving messages.
* @param[in] pReceiver Callback interface for receiving data and connect status.
* @return Returns 'true' when a channel connection could be initiated. Use GetStatus or IConnectEventCallback to
* @param[in] pReceiver Callback interface for receiving data and connect state.
* @return Returns 'true' when a channel connection could be initiated. Use GetConnectState or IConnectEventCallback to
* check the connection state.
*/
boolean AsyncConnect(in IInterfaceAccess pReceiver);
@@ -116,33 +116,32 @@ module sdv
void CancelWait();
/**
* @brief Disconnect from a connection. This will set the connect status to disconnected and release the interface
* used for the status events.
* @brief Disconnect from a connection. This will set the connect state to disconnected and release the interface
* used for the state events.
*/
void Disconnect();
/**
* @brief Register event callback interface.
* @details Register a connection status event callback interface. The exposed interface must be of type
* @details Register a connection state event callback interface. The exposed interface must be of type
* IConnectEventCallback. The registration will exist until a call to the unregister function with the returned cookie
* or until the connection is terminated.
* @param[in] pEventCallback Pointer to the object exposing the IConnectEventCallback interface.
* @return The cookie assigned to the registration or 0 when the registration wasn't successful.
*/
uint64 RegisterStatusEventCallback(in IInterfaceAccess pEventCallback);
uint64 RegisterStateEventCallback(in IInterfaceAccess pEventCallback);
/**
* @brief Unregister the status event callback with the returned cookie from the registration.
* @brief Unregister the state event callback with the returned cookie from the registration.
* @param[in] uiCookie The cookie returned by a previous call to the registration function.
*/
void UnregisterStatusEventCallback(in uint64 uiCookie);
void UnregisterStateEventCallback(in uint64 uiCookie);
/**
* @brief Gets the current status of the IPC whether it is initialized/connected/disconnected or having connection
* error.
* @return Returns retrieved status of the IPC.
* @brief Get the current state of the IPC conection.
* @return Returns connection state.
*/
EConnectStatus GetStatus() const;
EConnectState GetConnectState() const;
};
/**
@@ -151,10 +150,10 @@ module sdv
interface IConnectEventCallback
{
/**
* @brief Set the current status.
* @param[in] eConnectStatus The connection status.
* @brief Set the current connect state.
* @param[in] eConnectState The connection state.
*/
void SetStatus(in EConnectStatus eConnectStatus);
void SetConnectState(in EConnectState eConnectState);
};
/**

4
export/support/component_impl.h
View File

@@ -900,7 +900,7 @@ namespace sdv
// Lock the parameter map - do not allow any more changes
LockParamMap();
// Set status
// Set state
m_eObjectState = EObjectState::shutdown_in_progress;
// Inform derived class
@@ -1001,7 +1001,7 @@ namespace sdv
END_SDV_INTERFACE_MAP()
private:
std::atomic<EObjectState> m_eObjectState = EObjectState::initialization_pending; ///< Object status
std::atomic<EObjectState> m_eObjectState = EObjectState::initialization_pending; ///< Object state
std::string m_ssObjectConfig; ///< Copy of the configuration TOML.
};