ddest(n) [suse man page]

transfer::data::destination(n)				     Data transfer facilities				    transfer::data::destination(n)

__________________________________________________________________________________________________________________________________________________

NAME

       transfer::data::destination - Data destination

SYNOPSIS

       package require Tcl  8.4

       package require snit  ?1.0?

       package require transfer::data::destination  ?0.1?

       transfer::data::destination object ?options...?

       object destroy

       object put chunk

       object done

       object valid msgvar

       object receive channel done

_________________________________________________________________

DESCRIPTION

       This  package provides objects mainly describing the destination of a data transfer. They are also able to initiate the reception of infor-
       mation from a channel into the described destination.

API

       transfer::data::destination object ?options...?
	      This command creates and configures a new destination object. The fully qualified name of the object  command  is  returned  as  the
	      result of the command.

	      The  recognized options are listed below. It should be noted that all are semi-exclusive, each specifying a different type of desti-
	      nation and associated information. If these options are specified more than once then the last option specified is used to  actually
	      configure the object.

	      -channel handle
		     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.

	      -file path
		     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.

	      -variable varname
		     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.

       object destroy
	      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.

       object put chunk
	      The  main  receptor  method. Saves the received chunk of data into the configured destination. It has to be called for each piece of
	      data received.

       object done
	      The secondary receptor method. Finalizes the receiver. It has to be called when the receiving channel signals EOF. Afterward neither
	      itself nor method put can be called anymore.

       object valid msgvar
	      This  method  checks  the  configuration of the object for validity. It returns a boolean flag as result, whose value is True if the
	      object is valid, and False otherwise. In the latter case the variable whose name is stored in msgvar is  set  to	an  error  message
	      describing the problem found with the configuration. Otherwise this variable is not touched.

       object receive channel done
	      This  method initiates the reception of data from the specified channel. The received data will be stored into the configured desti-
	      nation, via calls to the methods put and done.  When the reception completes the command prefix done is invoked, with the number	of
	      received characters appended to it as the sole additional argument.

KEYWORDS

       channel, copy, data destination, transfer

COPYRIGHT

       Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>

transfer								0.1					    transfer::data::destination(n)

Check Out this Related Man Page

transfer::receiver(n)					     Data transfer facilities					     transfer::receiver(n)

__________________________________________________________________________________________________________________________________________________

NAME

       transfer::receiver - Data source

SYNOPSIS

       package require Tcl  8.4

       package require snit  ?1.0?

       package require transfer::data::destination  ?0.1?

       package require transfer::connect  ?0.1?

       package require transfer::receiver  ?0.1?

       transfer::receiver object ?options...?

       object destroy

       object start

       object busy

_________________________________________________________________

DESCRIPTION

       This package pulls data destinations and connection setup together into a combined object for the reception of information coming in over a
       socket. These objects understand all the options from objects created by the packages transfer::data::destination and transfer::connect.

API

       transfer::receiver object ?options...?
	      This command creates and configures a new receiver object. The fully qualified name of the object command is returned as the  result
	      of the command.

	      See  the	packages  transfer::data::destination  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 method receive, see package trans-
		     fer::data::destination.

       object destroy
	      This method destroys the object. Doing so while a reception is on progress will cause errors later on, when the reception  completes
	      and tries to access the now missing data structures of the destroyed object.

       object start
	      This  method initiates the data reception, setting up the connection first and then copying the received information into the desti-
	      nation. The method will throw an error if a reception is already/still in progress. I.e. it is not possible to run two receptions in
	      parallel,  only in sequence. Errors will also be thrown if the configuration of the data destination 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 reception 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 destination, receiver, transfer

COPYRIGHT

       Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>

transfer								0.1						     transfer::receiver(n)

Linux and UNIX Man Pages

ddest(n) [suse man page]

Check Out this Related Man Page