This manual page is for Mac OS X version 10.6.3

Reading manual pages

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 recog-nized. recognized.
              nized. 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 transfer::data::desti-nation. transfer::data::destination.
                     nation.

       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 destination. 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://source-
       forge.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)