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

NAME

8       transfer::transmitter - Data source
9

SYNOPSIS

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

DESCRIPTION

34       This  package  pulls  data sources and connection setup together into a
35       combined object for the transmission  of  information  over  a  socket.
36       These  objects  understand  all the options from objects created by the
37       packages transfer::data::source and transfer::connect.
38

API

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

KEYWORDS

81       channel, copy, data source, transfer, transmitter
82

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