ara::diag::FileTransfer类 参考

38 Simple interface classes for services. 更多...

#include <fileTransfer.h>

ara::diag::FileTransfer 的协作图:

类
struct	OperationOutput
	OperationOutput structure definition of FileTransfer class. 更多...

Public 成员函数
	FileTransfer (const ara::core::InstanceSpecifier &specifier)
	Constructor. 更多...
virtual	~FileTransfer ()
	destructor. 更多...
virtual ara::core::Future< OperationOutput >	RequestFileTransfer (uint8_t mode, uint16_t filePathAndNameLength, ByteVector fileInfomation)=0
	request file transfer. 更多...
virtual ara::core::Future< OperationOutput >	FileTransferData (ByteVector transferRequestParameterRecord)=0
	start transmission. 更多...
virtual ara::core::Future< OperationOutput >	RequestFileTransferExit (ByteVector transferRequestParameterRecord)=0
	stop transmission. 更多...
ara::core::Result< void >	Offer ()
	Provides a service, this method enables the DM to start listening for changes in the active line. 更多...
void	StopOffer ()
	StopOffer prohibits forwarding of messages delivered from DMs. 更多...

详细描述

38 Simple interface classes for services.

Swsid

N/A

符合标准

No

非标原因

custom interface

种类

class

符号

ara::diag::FileTransfer

范围

namespace ara::diag

基类

N/A

分类

ara

头文件

ara/diag/

注解

FileTransfer service for file transfer.

模板参数

N/A

在文件 第 行定义.

构造及析构函数说明

FileTransfer()

ara::diag::FileTransfer::FileTransfer ( const ara::core::InstanceSpecifier &  specifier )

explicit

Constructor.

模板参数

N/A

参数

[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

异常

N/A

Swsid

N/A

符合标准

no

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/fileTransfer.h

异常安全

N/A

分类

ara

在文件 第 行定义.

~FileTransfer()

ara::diag::FileTransfer::~FileTransfer ( )

virtual

destructor.

模板参数

N/A

参数

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

返回

N/A

注解

N/A

异常

N/A

Swsid

N/A

符合标准

no

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/fileTransfer.h

异常安全

N/A

分类

ara

在文件 第 行定义.

成员函数说明

FileTransferData()

virtual ara::core::Future<OperationOutput> ara::diag::FileTransfer::FileTransferData ( ByteVector  transferRequestParameterRecord )

pure virtual

start transmission.

模板参数

N/A

参数

[in]	transferRequestParameterRecord	The parameter record contains the parameters required by the server to support data transfer.
[out]	ara::core::Future<OperationOutput>
[in,out]	N/A

返回

ara::core::Future<OperationOutput>

注解

[Error]: N/A

异常

N/A

Swsid

N/A

符合标准

no

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/fileTransfer.h

异常安全

N/A

分类

ara

Offer()

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

(

)

Provides a service, this method enables the DM to start listening for changes in the active line.

模板参数

N/A

参数

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

返回

ara::core::Result<void>

注解

N/A

异常

N/A

Swsid

N/A

符合标准

no

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/fileTransfer.h

异常安全

N/A

分类

ara

在文件 第 行定义.

引用了 ara::diag::kAlreadyOffered.

RequestFileTransfer()

virtual ara::core::Future<OperationOutput> ara::diag::FileTransfer::RequestFileTransfer ( uint8_t  mode, uint16_t  filePathAndNameLength, ByteVector  fileInfomation  )

pure virtual

request file transfer.

模板参数

N/A

参数

[in]	mode	This data parameter specifies the type of operation to apply to the file or directory specified in the filePathAndName parameter.
[in]	filePathAndNameLength	length of file paths and names.
[in]	fileInfomation	file information.
[out]	ara::core::Future<OperationOutput>
[in,out]	N/A

返回

ara::core::Future<OperationOutput>

注解

N/A

异常

N/A

Swsid

N/A

符合标准

no

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/fileTransfer.h

异常安全

N/A

分类

ara

RequestFileTransferExit()

virtual ara::core::Future<OperationOutput> ara::diag::FileTransfer::RequestFileTransferExit ( ByteVector  transferRequestParameterRecord )

pure virtual

stop transmission.

模板参数

N/A

参数

[in]	transferRequestParameterRecord	The parameter record contains the parameters required by the server to support data transfer.
[out]	ara::core::Future<OperationOutput>
[in,out]	N/A

返回

ara::core::Future<OperationOutput>

注解

N/A

异常

N/A

Swsid

N/A

符合标准

no

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/fileTransfer.h

异常安全

N/A

分类

ara

StopOffer()

void ara::diag::FileTransfer::StopOffer

(

)

StopOffer prohibits forwarding of messages delivered from DMs.

模板参数

N/A

参数

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

返回

N/A

注解

N/A

异常

N/A

Swsid

N/A

符合标准

no

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/fileTransfer.h

异常安全

N/A

分类

ara

在文件 第 行定义.