|
ITFtp
|
Represents a single data transfer between a TFTP server and client.
Namespace: GSF.Net.TFtp
Assembly: GSF.Net (in GSF.Net.dll) Version: 2.4.181-beta
Syntaxpublic interface ITFtpTransfer : IDisposable
The ITFtpTransfer type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BlockCounterWrapping | TFTP can transfer up to 65535 blocks. After that, the block counter wraps to either zero or one, depending on the expectations of the client. |
| BlockSize | Transfer block size. Set this member to control the TFTP block size option (RFC 2349). |
| ExpectedSize | Expected transfer size in bytes. 0 if size is unknown. |
| Filename | Filename for the transferred file. |
| RetryCount | Number of times that a RetryTimeout may occur before the transfer is cancelled with a TimeoutError. |
| RetryTimeout | Timeout after which commands are sent again. This member is also transmitted as the TFTP timeout interval option (RFC 2349). |
| TransferMode | Requested TFTP transfer mode. For outgoing transfers, this member may be used to set the transfer mode. |
| UserContext | You can set your own object here to associate custom data with this transfer. |
Methods| Name | Description | |
|---|---|---|
 | Cancel | Cancel the currently running transfer, possibly sending the provided reason to the remote endpoint. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Start | Call this function to start the transfer. |
Events| Name | Description | |
|---|---|---|
 | OnError | Event that will be called if there is an error during the data transfer. Currently, this will return instances of ErrorFromRemoteEndpoint or NetworkError. |
| OnFinished | Event that will be called once the data transfer is finished. |
| OnProgress | Event that is being called while data is being transferred. |
See Also