Search: 
Available in: IP*WORKS!
Tftp Class
TFTP Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

The TFTPClient component is used to exchange files with TFTP servers via the TFTP protocol defined in RFC 783.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

To use the component, first specify the TFTPServer, then a LocalFile and a RemoteFile, and then call GetFile or PutFile. The Transfer event shows the progress of the transfer.

Potential transmission errors and packet loss are managed by the Timeout property which controls the maximum time to wait for a response from the server, and the MaxRetransmits property which specifies how many times to resend a failed packet before giving up.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

Idle The current status of the component.
LocalFile The file on the local host to transfer the data to/from.
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxRetransmits The number of times to retry sending a failed packet before disconnecting.
RemoteFile The file on the remote host.
RetransmitTimeout Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
TFTPPort The UDP port where the remote TFTP server is listening.
TFTPServer The address of the TFTP server to exchange files with.
Timeout A timeout for the component.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

Config Sets or retrieves a component configuration setting.
DoEvents Processes events from the internal message queue.
GetFile Download a RemoteFile from the TFTP server.
Interrupt Interrupt the current method.
PutFile Upload a file specified by LocalFile to the TFTP server.
SetDownloadStream Sets the stream to which the downloaded data from the server will be written.
SetUploadStream Sets the stream to be uploaded to the server.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

EndTransfer Fired when a file completes downloading/uploading.
Error Information about errors during data delivery.
StartTransfer Fired when a file starts downloading/uploading.
Transfer Fired during file download/upload.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
InBufferSize The size in bytes of the incoming queue of the socket.
MaxPacketSize The maximum length of the packets that can be received.
OutBufferSize The size in bytes of the outgoing queue of the socket.
ShareLocalPort If set to True, allows more than one instance of the component to be active on the same local port.
UseConnection Determines whether to use a connected socket.
UseIPv6 Whether or not to use IPv6.

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.