Author: Masanori Maruyama
Table of Contents
- Table of Contents
- 1. Executive Summary
- 2. Indexes and tables
- 3. Scope
- 4. Use case
- 4.1. The whole system
- 4.2. IC-Service IPC
- 5. Requirements
- 6. Architectural design
- 7. Interface definition
- 8. Component details
- 8.1. Other component
- 8.2. Designed component
- 8.2.1. Detailed design of internal APIs
- 8.2.1.1. IPC start for Client/Server
- 8.2.1.2. Callback function for Client
- 8.2.1.3. Send message from Server
- 8.2.1.4. Read received data by Client
- 8.2.1.5. IPC stop for Client/Server
- 8.2.2. Detection of change of data and callback notification
- 8.2.3. Setting path of socket file
- 8.3 Deployment view
...
2. Indexes and tables
2.1 Change history
| Revision | Date | Author | Description |
|---|---|---|---|
| 0.1 | 2021/03/22 | New entry. |
2.2 Referenced documents
| Tag | Document name | Location of documents |
|---|---|---|
| IC-Service_API_rev0.4.docx | ||
| Size_list_of_Data_Pool.xlsx | ||
| IC-EG Architecture Overview - Draft_200803a.pptx |
2.3. Glossary
| Term | Mean |
|---|---|
| - | - |
3. Scope
- This document is intended to be read by users of IC-Service IPC.
...
Components of use cases are described in the following table.
| Component | Description |
|---|---|
| App | App is a part of Cluster UI. App calls API functions for Cluster. |
| Cluster | Cluster is the library provides APIs to get data of IC-Service. It provides App the signal information received from IC-Service.たｂ Cluster runs as a part of App process because it is the layer called as function from App. |
| IPC | Inter Process Communication. This part provides functionalities to communicate to send signal information from IC-Service to Cluster or the reverse. It has data protocols and it is designed and implemented as the divertable part used by not only Cluster and IC-Service but also other domains. |
| IC-Service | IC-Service is a part to have vehicle internal information. It sends signal information to Cluster. It runs as another process from App process. |
4.2.1. Use cases of sending data through IPC
...
6.2.2.1. Startup/Initialization
6.2.2.2. Update DataPool
6.2.2.3. Process of getter API
...
IPC has the following internal apis. Details of the apis and how to use them in case of IC-Service are described in 8.2.1.
| Function name | Explanation | User | Section |
|---|---|---|---|
| ipcServerStart() | Start IPC Server. | Server | 8.2.1.1 |
| ipcSendMessage() | Send data to Client. | Server | 8.2.1.3 |
| ipcServerStop() | Stop IPC Server. | Server | 8.2.1.5 |
| ipcClientStart() | Start IPC Client and connect to the IPC Server which has same Domain. | Client | 8.2.1.1 |
| ipcReadDataPool() | Read the Data Pool which stores data received from Server. | Client | 8.2.1.4 |
| ipcRegisterCallback() | Register a callback function for notification of change of Data Pool. | Client | 8.2.1.2 |
| ipcClientStop() | Stop IPC Client. | Client | 8.2.1.5 |
7.3. Communication protocol
...