blob: 860b1ffa2ca7da721069f252faac9a99a60551d7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
[vset VERSION 1.0.3]
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin tcl::chan::string n [vset VERSION]]
[keywords {in-memory channel}]
[keywords {reflected channel}]
[keywords {tip 219}]
[keywords {virtual channel}]
[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
[moddesc {Reflected/virtual channel support}]
[category Channels]
[titledesc {Read-only in-memory channel}]
[require Tcl 8.5]
[require TclOO]
[require tcl::chan::events [opt 1]]
[require tcl::chan::string [opt [vset VERSION]]]
[description]
[para]
The [package tcl::chan::string] package provides a command creating
channels which live purely in memory. They provide random-access,
i.e. are seekable.
In contrast to the channels created by [package tcl::chan::memchan]
they are read-only however, their content is provided at the time of
construction and immutable afterward.
[para] Packages related to this are [package tcl::chan::memchan] and
[package tcl::chan::variable].
[para] The internal [package TclOO] class implementing the channel
handler is a sub-class of the [package tcl::chan::events] framework.
[section API]
[list_begin definitions]
[call [cmd ::tcl::chan::string] [arg content]]
This command creates a new string channel and returns its handle. The
channel provides random read-only access to the [arg content] string.
[list_end]
[vset CATEGORY virtchannel]
[include ../doctools2base/include/feedback.inc]
[manpage_end]
|
