IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

TFTP Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorks_TFTP

Procedural Interface

 ipworks_tftp_open();
 ipworks_tftp_close($res);
 ipworks_tftp_register_callback($res, $id, $function);
 ipworks_tftp_get_last_error($res);
 ipworks_tftp_get_last_error_code($res);
 ipworks_tftp_set($res, $id, $index, $value);
 ipworks_tftp_get($res, $id, $index);
 ipworks_tftp_do_config($res, $configurationstring);
 ipworks_tftp_do_doevents($res);
 ipworks_tftp_do_getfile($res);
 ipworks_tftp_do_interrupt($res);
 ipworks_tftp_do_putfile($res);

Remarks

To use the class, 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 class with short descriptions. Click on the links for further details.

IdleThe current status of the component.
LocalFileThe file on the local host to transfer the data to/from.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxRetransmitsThe number of times to retry sending a failed packet before disconnecting.
RemoteFileThe file on the remote host.
RetransmitTimeoutMaximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
TFTPPortThe UDP port where the remote TFTP server is listening.
TFTPServerThe address of the TFTP server to exchange files with.
TimeoutA timeout for the component.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
GetFileDownload a RemoteFile from the TFTP server.
InterruptInterrupt the current method.
PutFileUpload a file specified by LocalFile to the TFTP server.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

EndTransferFired when a file completes downloading/uploading.
ErrorInformation about errors during data delivery.
StartTransferFired when a file starts downloading/uploading.
TransferFired during file download/upload.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

TransferModeDetermines the transfer mode that will be used when transferring a file.
CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxPacketSizeThe maximum length of the packets that can be received.
ShareLocalPortIf set to True, allows more than one instance of the component to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0