dnp3.IFileReader Interface Reference

Callbacks for reading a file from the outstation asynchronously More...

Public Member Functions
bool	Opened (uint size)
	Called when the file is successfully opened More...
bool	BlockReceived (uint blockNum, System.Collections.Generic.ICollection< byte > data)
	Called when the next block is received More...
void	Aborted (FileError error)
	Called when the transfer is aborted before completion due to an error or user request More...
void	Completed ()
	Called when the transfer completes successfully More...

Detailed Description

Callbacks for reading a file from the outstation asynchronously

Member Function Documentation

Aborted()

void dnp3.IFileReader.Aborted

(

FileError

error

)

Called when the transfer is aborted before completion due to an error or user request

Parameters

error

Error describing why the transfer aborted

BlockReceived()

bool dnp3.IFileReader.BlockReceived	(	uint	blockNum,
		System.Collections.Generic.ICollection< byte >	data
	)

Called when the next block is received

May optionally abort the transfer. This allows the application abort on internal errors like being or by user request.

Parameters

blockNum	The block number which increments as the transfer proceeds
data	System.Collections.Generic.ICollection<T> of bytes in the block

Returns

True to continue, false to abort

Completed()

void dnp3.IFileReader.Completed

(

)

Called when the transfer completes successfully

Opened()

bool dnp3.IFileReader.Opened

(

uint

size

)

Called when the file is successfully opened

May optionally abort the operation by returning false

Parameters

size	Size of the file returned by the outstation

Returns

True to continue, false to abort

---

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

• IFileReader.cs