ara::diag::CommunicationControl类 参考

CommunicationControl interface. 更多...

#include <communication_control.h>

ara::diag::CommunicationControl 的协作图:

类
struct	ComCtrlRequestParamsType
	ComCtrlRequestParamsType is a structure, which holds all parameters of an UDS 0x28 communicationControl request. 更多...

Public 成员函数
	CommunicationControl (const ara::core::InstanceSpecifier &specifier, ReentrancyType reentrancyType)
	Class for an CommunicationControl. 更多...
virtual	~CommunicationControl () noexcept
	Destructor of class CommunicationControl. 更多...
virtual ara::core::Future< void >	CommCtrlRequest (ComCtrlRequestParamsType controlType, MetaInfo &metaInfo, CancellationHandler &cancellationHandler)=0
	Corresponding to 28 services. 更多...
ara::core::Result< void >	Offer ()
	This Offer will enable the DM to forward request messages to this handler. 更多...
void	StopOffer ()
	This StopOffer will disable the forwarding of request messages from DM. 更多...

详细描述

CommunicationControl interface.

Swsid

SWS_DM_00804

符合标准

yes

非标原因

N/A

种类

class

符号

CommunicationControl

范围

namespace ara::diag

基类

N/A

分类

ara

头文件

ara/diag/communication_control.h

注解

CommunicationControl service is used for communication control service.

模板参数

N/A

在文件 第 行定义.

构造及析构函数说明

CommunicationControl()

ara::diag::CommunicationControl::CommunicationControl ( const ara::core::InstanceSpecifier &  specifier, ReentrancyType  reentrancyType  )

explicit

Class for an CommunicationControl.

模板参数

N/A

参数

[in]	specifier	InstanceSpecifier to an PortPrototype of an DiagnosticCommunicationControlInterface
[in]	reentrancyType	specifies if interface is callable fully- or non-reentrant
[out]	N/A
[in,out]	N/A

返回

N/A

注解

N/A

异常

N/A

Swsid

SWS_DM_00806

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

no

Fireandforget

no

错误

N/A

头文件

ara/diag/communication_control.h

异常安全

N/A

分类

ara

在文件 第 行定义.

~CommunicationControl()

ara::diag::CommunicationControl::~CommunicationControl ( )

virtualnoexcept

Destructor of class CommunicationControl.

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回

N/A

注解

N/A

异常

N/A

Swsid

SWS_DM_00807

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

no

Fireandforget

no

错误

N/A

头文件

ara/diag/communication_control.h

异常安全

noexcept

分类

ara

在文件 第 行定义.

成员函数说明

CommCtrlRequest()

virtual ara::core::Future<void> ara::diag::CommunicationControl::CommCtrlRequest ( ComCtrlRequestParamsType  controlType, MetaInfo &  metaInfo, CancellationHandler &  cancellationHandler  )

pure virtual

Corresponding to 28 services.

模板参数

N/A

参数

[in]	controlType	All UDS request parameters packed into a structure since it holds optional elements
[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

异常

N/A

Swsid

SWS_DM_00808

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

no

Fireandforget

no

错误

DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kSubfunctionNotSupported

错误

DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kIncorrectMessageLengthOrInvalidFormat

错误

DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kConditionsNotCorrect

错误

DiagUdsNrcErrorDomain::DiagUdsNrcErrc::kRequestOutOfRange

头文件

ara/diag/communication_control.h

异常安全

N/A

分类

ara

Offer()

ara::core::Result< void > ara::diag::CommunicationControl::Offer

(

)

This Offer will enable the DM to forward request messages to this handler.

模板参数

N/A

参数

[in]	N/A
[out]	int
[in,out]	N/A

返回

ara::core::Result<void>

注解

N/A

异常

N/A

Swsid

SWS_DM_00809

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

no

Fireandforget

no

错误

DiagErrorDomain::DiagReportingErrc::kGenericError

错误

DiagErrorDomain::DiagOfferErrc::kAlreadyOffered

头文件

ara/diag/communication_control.h

异常安全

N/A

分类

ara

在文件 第 行定义.

引用了 ara::diag::kAlreadyOffered.

StopOffer()

void ara::diag::CommunicationControl::StopOffer

(

)

This StopOffer will disable the forwarding of request messages from DM.

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回

N/A

注解

N/A

异常

N/A

Swsid

SWS_DM_00810

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

no

Fireandforget

no

错误

N/A

头文件

ara/diag/communication_control.h

异常安全

N/A

分类

ara

在文件 第 行定义.