Simple interface class for DiagExternallyService objects.
更多...
#include <diag_externally_service.h>
|
| | DiagExternallyService (const InstanceSpecifier specifier) |
| | Constructor. 更多...
|
| |
| virtual | ~DiagExternallyService () |
| | destructor. 更多...
|
| |
| ara::core::Result< void > | Offer () |
| | Provides a service that enables the DM to forward the diagnostic service request to the diagnostic application for processing. 更多...
|
| |
| void | StopOffer () |
| | StopOffer prohibits forwarding of messages delivered from DMs. 更多...
|
| |
| int32_t | SetExternallyServiceControlNotifier (const DiagExternallyServiceSupportedService sid, const DiagExternallyServiceSupportedMessageType type, const std::function< RequestDoipUdsToAppResult(std::uint16_t source_address, std::uint16_t target_address, ByteVector payload)> notifier) |
| | Provides an interface for applications to control the diagnostic service process. 更多...
|
| |
| int32_t | SetExternallyServiceNotifier (const DiagExternallyServiceSupportedService sid, const DiagExternallyServiceSupportedMessageType type, const std::function< void(std::uint16_t source_address, std::uint16_t target_address, ByteVector payload)> notifier) |
| | Provides an interface for applications to synchronize messages for the diagnostic service process. 更多...
|
| |
Simple interface class for DiagExternallyService objects.
- Swsid
- N/A
- 符合标准
- No
- 非标原因
- custom interface
- 种类
- class
- 符号
- ara::diag::DiagExternallyService
- 范围
- namespace ara::diag
- 基类
- N/A
- 分类
- ara
- 头文件
- ara/diag/diag_externally_service.h
- 注解
- DiagExternallyService service is used for external service.
- 模板参数
-
在文件 第 行定义.
◆ DiagExternallyService()
| ara::diag::DiagExternallyService::DiagExternallyService |
( |
const InstanceSpecifier |
specifier | ) |
|
|
explicit |
Constructor.
- 模板参数
-
- 参数
-
| [in] | specifier | An instance designator of PortPrototype. InstanceSpecifier is an alias for std::string type. |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/diag_externally_service.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ ~DiagExternallyService()
| ara::diag::DiagExternallyService::~DiagExternallyService |
( |
| ) |
|
|
virtual |
destructor.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/diag_externally_service.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ Offer()
| ara::core::Result< void > ara::diag::DiagExternallyService::Offer |
( |
| ) |
|
Provides a service that enables the DM to forward the diagnostic service request to the diagnostic application for processing.
- 模板参数
-
- 参数
-
| [in] | N/A |
|
| [out] | ara::core::Result<void> | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<void>
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/diag_externally_service.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
引用了 ara::diag::kAlreadyOffered.
◆ SetExternallyServiceControlNotifier()
| int32_t ara::diag::DiagExternallyService::SetExternallyServiceControlNotifier |
( |
const DiagExternallyServiceSupportedService |
sid, |
|
|
const DiagExternallyServiceSupportedMessageType |
type, |
|
|
const std::function< RequestDoipUdsToAppResult(std::uint16_t source_address, std::uint16_t target_address, ByteVector payload)> |
notifier |
|
) |
| |
Provides an interface for applications to control the diagnostic service process.
- 模板参数
-
- 参数
-
| [in] | sid | Represents the diagnostic service process that the application wants to control. |
| [in] | type | Only supports DiagExternallyServiceSupportedMessageType::kRegisterControl. |
| [in] | notifier | Represents the callback function that the application wants to control the diagnostic service.
|
| [out] | int32_t | |
| [in,out] | N/A | |
- 返回
- int32_t
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/diag_externally_service.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ SetExternallyServiceNotifier()
| int32_t ara::diag::DiagExternallyService::SetExternallyServiceNotifier |
( |
const DiagExternallyServiceSupportedService |
sid, |
|
|
const DiagExternallyServiceSupportedMessageType |
type, |
|
|
const std::function< void(std::uint16_t source_address, std::uint16_t target_address, ByteVector payload)> |
notifier |
|
) |
| |
Provides an interface for applications to synchronize messages for the diagnostic service process.
- 模板参数
-
- 参数
-
| [in] | sid | Represents the diagnostic service process that the application wants to synchronize messages. |
| [in] | type | DiagExternallyServiceSupportedMessageType::kRegisterRequest represents the application wants to synchronize request messages and DiagExternallyServiceSupportedMessageType::kRegisterResponse represents the application wants to synchronize response messages. |
| [in] | notifier | Represents the callback function that the application wants to synchronize messages for the diagnostic service process. |
| [out] | int32_t | |
| [in,out] | N/A | |
- 返回
- int32_t
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/diag_externally_service.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ StopOffer()
| void ara::diag::DiagExternallyService::StopOffer |
( |
| ) |
|
StopOffer prohibits forwarding of messages delivered from DMs.
- 模板参数
-
- 参数
-
| [in] | N/A |
|
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/diag_externally_service.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
