tcl::chan::variable(3tcReflected/virtual channel supptcl::chan::variable(3tcl)
______________________________________________________________________________
NAME
tcl::chan::variable - In-memory channel using variable for storage
SYNOPSIS
package require Tcl 8.5
package require TclOO
package require tcl::chan::events ?1?
package require tcl::chan::variable ?1.0.4?
::tcl::chan::variable varname
______________________________________________________________________________
DESCRIPTION
The tcl::chan::variable package provides a command creating channels
which live purely in memory. They provide random-access, i.e. are seek-
able. In contrast to the channels created by tcl::chan::memchan the
data is not hidden in the channel however, but stored in an associated
variable, specified at the time of construction.
Packages related to this are tcl::chan::memchan and tcl::chan::string.
The internal TclOO class implementing the channel handler is a sub-
class of the tcl::chan::events framework.
API
::tcl::chan::variable varname
This command creates a new variable channel and returns its han-
dle. The content of the channel is stored in the associated
namespace variable varname.
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 Trackers [http://core.tcl.tk/tcllib/reportlist].
Please also report any ideas for enhancements you may have for either
package and/or documentation.
When proposing code changes, please provide unified diffs, i.e the out-
put of diff -u.
Note further that attachments are strongly preferred over inlined
patches. Attachments can be made by going to the Edit form of the
ticket immediately after its creation, and then using the left-most
button in the secondary navigation bar.
KEYWORDS
in-memory channel, reflected channel, tip 219, virtual channel
CATEGORY
Channels
COPYRIGHT
Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>
tcllib 1.0.4 tcl::chan::variable(3tcl)