'\" '\" Generated from file 'ddest\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2006-2009 Andreas Kupries '\" .TH "transfer::data::destination" 3tcl 0\&.2 tcllib "Data transfer facilities" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME transfer::data::destination \- Data destination .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp package require \fBsnit ?1\&.0?\fR .sp package require \fBtransfer::data::destination ?0\&.2?\fR .sp \fBtransfer::data::destination\fR \fIobjectName\fR ?\fIoptions\fR\&.\&.\&.? .sp \fIobjectName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? .sp \fIobjectName\fR \fBdestroy\fR .sp \fIobjectName\fR \fBput\fR \fIchunk\fR .sp \fIobjectName\fR \fBdone\fR .sp \fIobjectName\fR \fBvalid\fR \fImsgvar\fR .sp \fIobjectName\fR \fBreceive\fR \fIchannel\fR \fIdone\fR .sp .BE .SH DESCRIPTION .PP This package provides objects mainly describing the destination of a data transfer\&. They are also able to initiate the reception of information from a channel into the described destination\&. .SH API .TP \fBtransfer::data::destination\fR \fIobjectName\fR ?\fIoptions\fR\&.\&.\&.? This command creates a new data destination object with an associated Tcl command whose name is \fIobjectName\fR\&. This \fIobject\fR command is explained in full detail in the sections \fBObject command\fR and \fBObject methods\fR\&. The set of supported \fIoptions\fR is explained in section \fBOptions\fR\&. .sp The object command will be created under the current namespace if the \fIobjectName\fR is not fully qualified, and in the specified namespace otherwise\&. The fully qualified name of the object command is returned as the result of the command\&. .PP .SS "OBJECT COMMAND" All objects created by the \fB::transfer::data::destination\fR command have the following general form: .TP \fIobjectName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? The method \fBmethod\fR and its \fIarg\fR'uments determine the exact behavior of the command\&. See section \fBObject methods\fR for the detailed specifications\&. .PP .SS "OBJECT METHODS" .TP \fIobjectName\fR \fBdestroy\fR This method destroys the object\&. Doing so while the object is busy with the reception of information from a channel will cause errors later on, when the reception completes and tries to access the now missing data structures of the destroyed object\&. .TP \fIobjectName\fR \fBput\fR \fIchunk\fR The main receptor method\&. Saves the received \fIchunk\fR of data into the configured destination\&. It has to be called for each piece of data received\&. .TP \fIobjectName\fR \fBdone\fR The secondary receptor method\&. Finalizes the receiver\&. It has to be called when the receiving channel signals EOF\&. Afterward neither itself nor method \fBput\fR can be called anymore\&. .TP \fIobjectName\fR \fBvalid\fR \fImsgvar\fR This method checks the configuration of the object for validity\&. It returns a boolean flag as result, whose value is \fBTrue\fR if the object is valid, and \fBFalse\fR otherwise\&. In the latter case the variable whose name is stored in \fImsgvar\fR is set to an error message describing the problem found with the configuration\&. Otherwise this variable is not touched\&. .TP \fIobjectName\fR \fBreceive\fR \fIchannel\fR \fIdone\fR This method initiates the reception of data from the specified \fIchannel\fR\&. The received data will be stored into the configured destination, via calls to the methods \fBput\fR and \fBdone\fR\&. When the reception completes the command prefix \fIdone\fR is invoked, with the number of received characters appended to it as the sole additional argument\&. .PP .SS OPTIONS All data destinations support the options listed below\&. It should be noted that all are semi-exclusive, each specifying a different type of destination and associated information\&. If these options are specified more than once then the last option specified is used to actually configure the object\&. .TP \fB-channel\fR \fIhandle\fR This option specifies that the destination of the data is a channel, and its associated argument is the handle of the channel to write the received data to\&. .TP \fB-file\fR \fIpath\fR This option specifies that the destination of the data is a file, and its associated argument is the path of the file to write the received data to\&. .TP \fB-variable\fR \fIvarname\fR This option specifies that the destination of the data is a variable, and its associated argument contains the name of the variable to write the received data to\&. The variable is assumed to be global or namespaced, anchored at the global namespace\&. .TP \fB-progress\fR \fIcommand\fR This option, if specified, defines a command to be invoked for each chunk of bytes received, allowing the user to monitor the progress of the reception of the data\&. The callback is always invoked with one additional argument, the number of bytes received so far\&. .PP .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such in the category \fItransfer\fR of the \fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&. Please also report any ideas for enhancements you may have for either package and/or documentation\&. .PP When proposing code changes, please provide \fIunified diffs\fR, i\&.e the output of \fBdiff -u\fR\&. .PP Note further that \fIattachments\fR are strongly preferred over inlined patches\&. Attachments can be made by going to the \fBEdit\fR form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar\&. .SH KEYWORDS channel, copy, data destination, transfer .SH CATEGORY Transfer module .SH COPYRIGHT .nf Copyright (c) 2006-2009 Andreas Kupries .fi