Callback interface for handling incoming TemporaryFileTransfer Method calls. More...

#include <opcua_temporaryfiletransfertype.h>

Public Member Functions
virtual UaStatus	CloseAndCommit (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, UaNodeId &CompletionStateMachine, TemporaryFileTransferType *pFileTransfer)=0
	Close and commit the transaction. More...

virtual UaStatus	GenerateFileForRead (const ServiceContext &serviceContext, const UaVariant &GenerateOptions, UaNodeId &FileNodeId, OpcUa_UInt32 &FileHandle, UaNodeId &CompletionStateMachine, TemporaryFileTransferType *pFileTransfer)=0
	GenerateFileForRead is used to start the read file transaction. More...

virtual UaStatus	GenerateFileForWrite (const ServiceContext &serviceContext, const UaVariant &GenerateOptions, UaNodeId &FileNodeId, OpcUa_UInt32 &FileHandle, TemporaryFileTransferType *pFileTransfer)=0
	GenerateFileForWrite is used to start the write file transaction. More...

Detailed Description

Callback interface for handling incoming TemporaryFileTransfer Method calls.

Member Function Documentation

virtual UaStatus OpcUa::TemporaryFileTransferTypeCallback::CloseAndCommit	(	const ServiceContext &	serviceContext,
		OpcUa_UInt32	FileHandle,
		UaNodeId &	CompletionStateMachine,
		TemporaryFileTransferType *	pFileTransfer
	)

pure virtual

Close and commit the transaction.

CloseAndCommit is used to apply the content of the written file and to delete the temporary file after the completion of the transaction.

Method Result Codes

Result Code	Description
Bad_UserAccessDenied	The user does not have permission to perform the requested operation.

Parameters

	serviceContext	General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]	FileHandle	The fileHandle used to write the file.
[out]	CompletionStateMachine	If the processing of the file is completed asynchronous, the parameter returns the NodeId of the corresponding FileTransferStateMachineType Object. If the processing of the file is already completed, the parameter is null. If a FileTransferStateMachineType Object NodeId is returned, the processing is in progress until the TransferState changed to Idle.
	pFileTransfer	Affected Object Node.

virtual UaStatus OpcUa::TemporaryFileTransferTypeCallback::GenerateFileForRead	(	const ServiceContext &	serviceContext,
		const UaVariant &	GenerateOptions,
		UaNodeId &	FileNodeId,
		OpcUa_UInt32 &	FileHandle,
		UaNodeId &	CompletionStateMachine,
		TemporaryFileTransferType *	pFileTransfer
	)

pure virtual

GenerateFileForRead is used to start the read file transaction.

A successful call of this Method creates a temporary FileType Object with the file content and returns the NodeId of this Object and the file handle to access the Object.

Method Result Codes

Result Code	Description
Bad_UserAccessDenied	The user does not have permission to perform the requested operation.

Parameters

	serviceContext	General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]	GenerateOptions	The optional parameter can be used to specify server specific file generation options. To allow such options, the Server shall specify a concrete DataType in the Argument Structure for this argument in the instance of the Method. If the DataType is BaseDataType, the Client passes Null for this argument.
[out]	FileNodeId	NodeId of the temporary file.
[out]	FileHandle	The fileHandle of the opened TransferFile. The fileHandle can be used to access the TransferFile Methods Read and Close.
[out]	CompletionStateMachine	If the creation of the file is completed asynchronous, the parameter returns the NodeId of the corresponding FileTransferStateMachineType Object. If the creation of the file is already completed, the parameter is null. If a FileTransferStateMachineType Object NodeId is returned, the Read Method of the file fails until the TransferState changed to ReadTransfer.
	pFileTransfer	Affected Object Node.

virtual UaStatus OpcUa::TemporaryFileTransferTypeCallback::GenerateFileForWrite	(	const ServiceContext &	serviceContext,
		const UaVariant &	GenerateOptions,
		UaNodeId &	FileNodeId,
		OpcUa_UInt32 &	FileHandle,
		TemporaryFileTransferType *	pFileTransfer
	)

pure virtual

GenerateFileForWrite is used to start the write file transaction.

A successful call of this Method creates a temporary FileType Object and returns the NodeId of this Object and the file handle to access the Object.

Method Result Codes

Result Code	Description
Bad_UserAccessDenied	The user does not have permission to perform the requested operation.

Parameters

	serviceContext	General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]	GenerateOptions	The optional parameter can be used to specify server specific file generation options. To allow such options, the Server shall specify a concrete DataType in the Argument Structure for this argument in the instance of the Method. If the DataType is BaseDataType, the Client passes Null for this argument.
[out]	FileNodeId	NodeId of the temporary file.
[out]	FileHandle	The fileHandle of the opened TransferFile. The fileHandle can be used to access the TransferFile Methods Write and Close.
	pFileTransfer	Affected Object Node.

The documentation for this class was generated from the following file:

C:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_temporaryfiletransfertype.h

Public Member Functions

Detailed Description

Member Function Documentation