Download service interface.
更多...
#include <download.h>
Download service interface.
- Swsid
- SWS_DM_00784
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- class
- 符号
- DownloadService
- 范围
- namespace ara::diag
- 基类
- N/A
- 分类
- ara
- 头文件
- ara/diag/download.h
- 注解
- DownloadService service is used for burning service.
- 模板参数
-
在文件 第 行定义.
◆ DownloadService()
| ara::diag::DownloadService::DownloadService |
( |
const ara::core::InstanceSpecifier & |
specifier, |
|
|
ReentrancyType |
reentrancyType |
|
) |
| |
|
explicit |
Class for an DownloadService.
- 模板参数
-
- 参数
-
| [in] | specifier | InstanceSpecifier to an PortPrototype of an DownloadServiceInterface |
| [in] | reentrancyType | specifies if interface is callable fully- or non-reentrant |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00787
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/download.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ ~DownloadService()
| ara::diag::DownloadService::~DownloadService |
( |
| ) |
|
|
virtualnoexcept |
Destructor of class DownloadService.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00788
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/download.h
- 异常安全
- noexcept
- 分类
- ara
在文件 第 行定义.
◆ DownloadData()
| virtual ara::core::Future<OperationOutput> ara::diag::DownloadService::DownloadData |
( |
ara::core::Span< std::uint8_t > |
transferRequestParameterRecord, |
|
|
MetaInfo & |
metaInfo, |
|
|
CancellationHandler & |
cancellationHandler |
|
) |
| |
|
pure virtual |
Called for TransferData following a previous RequestDownload.
- 模板参数
-
- 参数
-
| [in] | transferRequestParameterRecord | data to be transferred (copied/downloaded to the ECU/server). |
| [in] | metaInfo | contains additional meta information. |
| [in] | cancellationHandler | informs if the current conversation is canceled. |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00790
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kIncorrectMessageLengthOrInvalidFormat
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kRequestSequenceError
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kRequestOutOfRange
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kTransferDataSuspended
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kGeneralProgrammingFailure
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kWrongBlockSequenceCounter
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kVoltageTooHigh
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kVoltageTooLow
- 头文件
- ara/diag/download.h
- 异常安全
- N/A
- 分类
- ara
◆ Offer()
| ara::core::Result< void > ara::diag::DownloadService::Offer |
( |
| ) |
|
This Offer will enable the DM to forward request messages to this handler.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<void>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00792
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- DiagErrorDomain::DiagReportingErrc::kGenericError
- 错误
- DiagErrorDomain::DiagOfferErrc::kAlreadyOffered
- 头文件
- ara/diag/download.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
引用了 ara::diag::kAlreadyOffered.
◆ RequestDownload()
| virtual ara::core::Future<void> ara::diag::DownloadService::RequestDownload |
( |
std::uint8_t |
dataFormatIdentifier, |
|
|
std::uint8_t |
addressAndLengthFormatIdentifier, |
|
|
ara::core::Span< std::uint8_t > |
memoryAddressAndSize, |
|
|
MetaInfo & |
metaInfo, |
|
|
CancellationHandler & |
cancellationHandler |
|
) |
| |
|
pure virtual |
Called for RequestDownload.
- 模板参数
-
- 参数
-
| [in] | dataFormatIdentifier | UDS dataFormat Identifier. |
| [in] | addressAndLengthFormatIdentifier | UDS addressAndLengthFormatIdentifier. |
| [in] | memoryAddressAndSize | memoryAddress and memorySize part of the request. |
| [in] | metaInfo | contains additional meta information. |
| [in] | cancellationHandler | informs if the current conversation is canceled. |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<void>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00789
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kIncorrectMessageLengthOrInvalidFormat
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kConditionsNotCorrect
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kRequestOutOfRange
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kSecurityAccessDenied
- 错误
- DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kUploadDownloadNotAccepted
- 头文件
- ara/diag/download.h
- 异常安全
- N/A
- 分类
- ara
◆ RequestDownloadExit()
| virtual ara::core::Future<OperationOutput> ara::diag::DownloadService::RequestDownloadExit |
( |
ara::core::Span< std::uint8_t > |
transferRequestParameterRecord, |
|
|
MetaInfo & |
metaInfo, |
|
|
CancellationHandler & |
cancellationHandler |
|
) |
| |
|
pure virtual |
Called for RequestTransferExit.
- 模板参数
-
- 参数
-
| [in] | transferRequestParameterRecord | This parameter record contains parameter(s), which are required by the server to support the transfer of data.Format and length of this parameter(s) are vehicle manufacturer specific. |
| [in] | metaInfo | contains additional meta information. |
| [in] | cancellationHandler | informs if the current conversation is canceled. |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00791
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- Any applicable NegativeResponseValue according to DiagUdsNrcErrc
- 头文件
- ara/diag/download.h
- 异常安全
- N/A
- 分类
- ara
◆ StopOffer()
| void ara::diag::DownloadService::StopOffer |
( |
| ) |
|
This StopOffer will disable the forwarding of request messages from DM.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00793
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/download.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.