|
|
XFB file transfer
|
|
transfer::transmitter(n) Data transfer facilities transfer::transmitter(n) __________________________________________________________________________________________________________________________________________________ NAME
transfer::transmitter - Data source SYNOPSIS
package require Tcl 8.4 package require snit ?1.0? package require transfer::copy ?0.1? package require transfer::data::source ?0.1? package require transfer::connect ?0.1? package require transfer::transmitter ?0.1? transfer::transmitter object ?options...? object destroy object start object busy _________________________________________________________________ DESCRIPTION
This package pulls data sources and connection setup together into a combined object for the transmission of information over a socket. These objects understand all the options from objects created by the packages transfer::data::source and transfer::connect. API
transfer::transmitter object ?options...? This command creates and configures a new transmitter object. The fully qualified name of the object command is returned as the result of the command. See the packages transfer::data::source and transfer::connect for the main options recognized. Here we describe only the options which go beyond the referenced set. -command cmdprefix This option specifies the command to invoke when the transmission of the information in the data source has been completed. The arguments given to this command are the same as given to the completion callback of command transfer::copy::do, see pack- age transfer::copy. -blocksize int This option specifies the size of the chunk to be transmitted in one block. It is optional and defaults to 1024. object destroy This method destroys the object. Doing so while a transmission is on progress will cause errors later on, when the transmission com- pletes and tries to access the now missing data structures of the destroyed object. object start This method initiates the data transmission, setting up the connection first and then copying the information. The method will throw an error if a transmission is already/still in progress. I.e. it is not possible to run two transmissions in parallel, only in sequence. Errors will also be thrown if the configuration of the data source is invalid, or if no completion callback was specified. The result returned by the method the same as the result of method connect, see package transfer::connect. object busy This method returns a boolean value telling us whether a transmission is in progress (True), or not (False). BUGS, IDEAS, FEEDBACK This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category transfer of the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883]. Please also report any ideas for enhancements you may have for either package and/or documentation. KEYWORDS
channel, copy, data source, transfer, transmitter COPYRIGHT
Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net> transfer 0.1 transfer::transmitter(n)
