1tcl::transform::core(n)Reflected/virtual channel supporttcl::transform::core(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       tcl::transform::core  -  Basic reflected/virtual channel transform sup‐
9       port
10

SYNOPSIS

12       package require Tcl  8.5
13
14       package require TclOO
15
16       package require tcl::transform::core  ?1?
17
18       ::tcl::transform::core objectName
19
20       objectName initialize thechannel mode
21
22       objectName finalize thechannel
23
24       objectName destroy
25
26______________________________________________________________________________
27

DESCRIPTION

29       The tcl::transform::core package provides a  TclOO  class  implementing
30       common behaviour needed by virtually every reflected or virtual channel
31       transformation (initialization, finalization).
32
33       This class expects to be used as either superclass of a concrete  chan‐
34       nel class, or to be mixed into such a class.
35

CLASS API

37       ::tcl::transform::core objectName
38              This command creates a new transform core object with an associ‐
39              ated global Tcl command whose name is objectName.  This  command
40              may  be  used to invoke various operations on the object, as de‐
41              scribed in the section for the Instance API.
42

INSTANCE API

44       The API of transform core instances provides  only  two  methods,  both
45       corresponding  to transform handler commands (For reference see TIP 230
46       [http:/tip.tcl.tk/230]). They expect to be called from whichever object
47       instance the transform core was made a part of.
48
49       objectName initialize thechannel mode
50              This  method  implements  standard  behaviour for the initialize
51              method of transform handlers. Using introspection it  finds  the
52              handler  methods  supported  by  the instance and returns a list
53              containing their names, as expected by the support for reflected
54              transformation in the Tcl core.
55
56              It  further remembers the channel handle in an instance variable
57              for access by sub-classes.
58
59       objectName finalize thechannel
60              This method  implements  standard  behaviour  for  the  finalize
61              method of channel handlers. It simply destroys itself.
62
63       objectName destroy
64              Destroying  the  transform  core instance closes the channel and
65              transform it was initialized for,  see  the  method  initialize.
66              When destroyed from within a call of finalize this does not hap‐
67              pen, under the assumption that the channel and transform are be‐
68              ing destroyed by Tcl.
69

BUGS, IDEAS, FEEDBACK

71       This  document,  and the package it describes, will undoubtedly contain
72       bugs and other problems.  Please report such in the category  virtchan‐
73       nel  of  the  Tcllib  Trackers  [http://core.tcl.tk/tcllib/reportlist].
74       Please also report any ideas for enhancements you may have  for  either
75       package and/or documentation.
76
77       When proposing code changes, please provide unified diffs, i.e the out‐
78       put of diff -u.
79
80       Note further that  attachments  are  strongly  preferred  over  inlined
81       patches.  Attachments  can  be  made  by  going to the Edit form of the
82       ticket immediately after its creation, and  then  using  the  left-most
83       button in the secondary navigation bar.
84

KEYWORDS

86       reflected channel, tip 219, virtual channel
87

CATEGORY

89       Channels
90

92       Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>
93
94
95
96
97tcllib                                 1               tcl::transform::core(n)
Impressum