Used to access a File object on an OPC UA Server. More...

Inherits UnifiedAutomation.UaClient.SessionMethodHelper.

Public Member Functions
	FileTransfer (ApplicationInstance application)
	Initializes a new instance of the FileTransfer class. More...

	FileTransfer (Session session)
	Initializes a new instance of the FileTransfer class. More...

int	Read (Stream istrm, int blockSize)
	Reads a file from the server. More...

IAsyncResult	BeginRead (Stream istrm, int blockSize, AsyncCallback callback, object callbackData)
	Begins an operation to read a file from the server. More...

int	EndRead (IAsyncResult result)
	Completes an operation to read a file from the server. More...

int	Write (Stream ostrm, int blockSize)
	Writes a file to the server. More...

IAsyncResult	BeginWrite (Stream ostrm, int blockSize, AsyncCallback callback, object callbackData)
	Begins an operation to write a file to the server. More...

int	EndWrite (IAsyncResult result)
	Completes an operation to write the file to the server. More...

Public Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
	SessionMethodHelper (ApplicationInstance application)
	Initializes a new instance of the SessionMethodHelper class. More...

	SessionMethodHelper (Session session)
	Initializes a new instance of the SessionMethodHelper class. More...

void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

void	Connect (int timeout)
	Connects to the server. More...

void	BeginConnect (AsyncCallback callback, object callbackData)
	Connects to the server. More...

void	Disconnect ()
	Disconnects from the server. More...

Properties
NodeId	FileId `[get, set]`
	Gets or sets the NodeId of the file object. More...

int	DefaultBlockSize `[get, set]`
	Gets or sets the default size of the block. More...

Properties inherited from UnifiedAutomation.UaClient.SessionMethodHelper
string	EndpointUrl `[get, set]`
	Gets or sets the endpoint URL. More...

Session	Session `[get, set]`
	Gets the session. More...

RequestSettings	DefaultRequestSettings `[get, set]`
	Gets or sets the default request settings. More...

int	DefaultTimeout `[get]`
	Gets the default timeout. More...

UserIdentity	AdminCredentials `[get, set]`
	Gets or sets the administrator credentials. More...

bool	IsConnected `[get]`
	Gets a value indicating whether a connection to the server is active. More...

Additional Inherited Members
Protected Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
virtual void	Dispose (bool disposing)
	Releases unmanaged and—optionally—managed resources. More...

UserIdentity	RequestAdminCredentials ()
	Gets the admin credentials. More...

Events inherited from UnifiedAutomation.UaClient.SessionMethodHelper
EventHandler	ServerStatusChanged
	Occurs when the server status changes. More...

EventHandler < CredentialsRequiredEventArgs >	AdminCredentialsRequired
	Raised when admin credentials are required. More...

Detailed Description

Used to access a File object on an OPC UA Server.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.FileTransfer.FileTransfer ( ApplicationInstance application )

inline

Initializes a new instance of the FileTransfer class.

Parameters

application The application to use.

UnifiedAutomation.UaClient.FileTransfer.FileTransfer ( Session session )

inline

Initializes a new instance of the FileTransfer class.

Parameters

session The session to use.

Member Function Documentation

IAsyncResult UnifiedAutomation.UaClient.FileTransfer.BeginRead	(	Stream	istrm,
		int	blockSize,
		AsyncCallback	callback,
		object	callbackData
	)

inline

Begins an operation to read a file from the server.

Parameters

istrm	The stream used to write the blocks as they are read from the server.
blockSize	Size of the blocks to to read. If blockSize is smaller or equal to 0, the DefaultBlockSize is used.
callback	The callback.
callbackData	The callback data.

Returns: The object used to manage the state of the asynchronous operation.

IAsyncResult UnifiedAutomation.UaClient.FileTransfer.BeginWrite	(	Stream	ostrm,
		int	blockSize,
		AsyncCallback	callback,
		object	callbackData
	)

inline

Begins an operation to write a file to the server.

Parameters

ostrm	The stream used to read the file to upload to the server.
blockSize	Size of the block to use when writing the the file. If 0, the DefaultBlockSize is used.
callback	The callback.
callbackData	The callback data.

Returns: The object used to manage the state of the asynchronous operation.

int UnifiedAutomation.UaClient.FileTransfer.EndRead ( IAsyncResult result )

inline

Completes an operation to read a file from the server.

Parameters

result The object used to manage the state of the asynchronous operation.

Returns: The number of bytes read from the server.

int UnifiedAutomation.UaClient.FileTransfer.EndWrite ( IAsyncResult result )

inline

Completes an operation to write the file to the server.

Parameters

result The object used to manage the state of the asynchronous operation.

Returns: The number of bytes written to the server.

int UnifiedAutomation.UaClient.FileTransfer.Read	(	Stream	istrm,
		int	blockSize
	)

inline

Reads a file from the server.

Parameters

istrm	The stream used to write the blocks as they are read from the server.
blockSize	Size of the blocks to to read. If blockSize is smaller or equal to 0, the DefaultBlockSize is used.

Returns: The number of bytes read from the server.

int UnifiedAutomation.UaClient.FileTransfer.Write	(	Stream	ostrm,
		int	blockSize
	)

inline

Writes a file to the server.

Parameters

ostrm	The stream used to read the file to upload to the server.
blockSize	Size of the block to use when writing the the file. If 0, the DefaultBlockSize is used.

Returns: The number of bytes written to the server.

Property Documentation

int UnifiedAutomation.UaClient.FileTransfer.DefaultBlockSize

getset

Gets or sets the default size of the block.

NodeId UnifiedAutomation.UaClient.FileTransfer.FileId

getset

Gets or sets the NodeId of the file object.

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

C:/work/uasdknet/src/UaClient/FileTransfer.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation