1transfer::receiver(n)      Data transfer facilities      transfer::receiver(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       transfer::receiver - Data source
9

SYNOPSIS

11       package require Tcl  8.4
12
13       package require snit  ?1.0?
14
15       package require transfer::data::destination  ?0.1?
16
17       package require transfer::connect  ?0.1?
18
19       package require transfer::receiver  ?0.1?
20
21       transfer::receiver object ?options...?
22
23       object destroy
24
25       object start
26
27       object busy
28
29_________________________________________________________________
30

DESCRIPTION

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

API

38       transfer::receiver object ?options...?
39              This command creates and configures a new receiver  object.  The
40              fully  qualified  name  of the object command is returned as the
41              result of the command.
42
43              See the packages transfer::data::destination and  transfer::con‐
44              nect  for the main options recognized. Here we describe only the
45              options which go beyond the referenced set.
46
47              -command cmdprefix
48                     This option specifies the  command  to  invoke  when  the
49                     transmission  of  the  information in the data source has
50                     been completed. The arguments given to this  command  are
51                     the  same  as  given to the completion callback of method
52                     receive, see package transfer::data::destination.
53
54       object destroy
55              This method destroys the object. Doing so while a  reception  is
56              on  progress will cause errors later on, when the reception com‐
57              pletes and tries to access the now missing  data  structures  of
58              the destroyed object.
59
60       object start
61              This method initiates the data reception, setting up the connec‐
62              tion first and then copying the received  information  into  the
63              destination.  The  method  will throw an error if a reception is
64              already/still in progress. I.e. it is not possible  to  run  two
65              receptions  in  parallel,  only in sequence. Errors will also be
66              thrown if the configuration of the data destination is  invalid,
67              or if no completion callback was specified.  The result returned
68              by the method the same as the  result  of  method  connect,  see
69              package transfer::connect.
70
71       object busy
72              This  method returns a boolean value telling us whether a recep‐
73              tion is in progress (True), or not (False).
74

BUGS, IDEAS, FEEDBACK

76       This document, and the package it describes, will  undoubtedly  contain
77       bugs  and  other problems.  Please report such in the category transfer
78       of       the       Tcllib       SF       Trackers       [http://source‐
79       forge.net/tracker/?group_id=12883].   Please  also report any ideas for
80       enhancements you may have for either package and/or documentation.
81

KEYWORDS

83       channel, copy, data destination, receiver, transfer
84

86       Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>
87
88
89
90
91transfer                              0.1                transfer::receiver(n)
Impressum