tcl::transform::counterReflected/virtual channel suptcl::transform::counter(n)______________________________________________________________________________NAME
tcl::transform::counter - Counter transformation
SYNOPSIS
package require Tcl 8.6
package require tcl::transform::core ?1?
package require tcl::transform::counter ?1?
::tcl::transform::counter chan -option value...
_________________________________________________________________DESCRIPTION
The tcl::transform::counterr package provides a command creating a
channel transformation which passes the read and written bytes through
unchanged (like tcl::transform::identity), but additionally counts the
bytes it has seen for each direction and stores these counts in Tcl
variables specified at construction time.
Related transformations in this module are tcl::transform::adler32,
tcl::transform::crc32, tcl::transform::identity, and tcl::trans‐
form::observe.
The internal TclOO class implementing the transform handler is a sub-
class of the tcl::transform::core framework.
API
::tcl::transform::counter chan -option value...
This command creates a counter transformation on top of the
channel chan and returns its handle. The accepted options are
-read-variable varname
The value of the option is the name of a global or names‐
paced variable, the location where the transformation has
to store the byte count of the data read from the chan‐
nel.
If not specified, or the empty string, the counter of the
read direction is not saved.
-write-variable varname
The value of the option is the name of a global or names‐
paced variable, the location where the transformation has
to store the byte count of the data written to the chan‐
nel.
If not specified, or the empty string, the counter of the
write direction is not saved.
BUGS, IDEAS, FEEDBACK
This document, and the package it describes, will undoubtedly contain
bugs and other problems. Please report such in the category virtchan‐
nel 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 transformation, counter, reflected channel, tip 230, transfor‐
mation, virtual channel
CATEGORY
Channels
COPYRIGHT
Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>
virtchannel_transform 1 tcl::transform::counter(n)
