Tcl Library Source Code

Documentation
Login


[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

NAME

transfer::data::source - Data source

Table Of Contents

SYNOPSIS

package require Tcl 8.4
package require snit ?1.0?
package require transfer::copy ?0.2?
package require transfer::data::source ?0.2?

transfer::data::source objectName ?options...?
objectName method ?arg arg ...?
objectName destroy
objectName type
objectName data
objectName size
objectName valid msgvar
objectName transmit channel blocksize done

DESCRIPTION

This package provides objects mainly describing the origin of some data to transfer. They are also able to initiate transfers of the described information to a channel using the foundation package transfer::copy.

API

Package commands

Object command

All objects created by the ::transfer::data::source command have the following general form:

Object methods

Options

All data sources support the options listed below. It should be noted that the first four options are semi-exclusive, each specifying a different type of data source and associated content. If these options are specified more than once then the last option specified is used to actually configure the object.

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 Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

KEYWORDS

channel, copy, data source, transfer

CATEGORY

Transfer module

COPYRIGHT

Copyright © 2006-2009 Andreas Kupries