1[comment {-*- tcl -*- doctools manpage}] 2[manpage_begin tcl::chan::string n 1] 3[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}] 4[moddesc {Reflected/virtual channel support}] 5[category Channels] 6[titledesc {Read-only in-memory channel}] 7[require Tcl 8.5] 8[require TclOO] 9[require tcl::chan::events [opt 1]] 10[require tcl::chan::string [opt 1]] 11[description] 12[para] 13 14The [package tcl::chan::string] package provides a command creating 15channels which live purely in memory. They provide random-access, 16i.e. are seekable. 17 18In contrast to the channels created by [package tcl::chan::memchan] 19they are read-only however, their content is provided at the time of 20construction and immutable afterward. 21 22[para] Packages related to this are [package tcl::chan::memchan] and 23[package tcl::chan::variable]. 24 25[para] The internal [package TclOO] class implementing the channel 26handler is a sub-class of the [package tcl::chan::events] framework. 27 28[section API] 29 30[list_begin definitions] 31 32[call [cmd ::tcl::chan::string] [arg content]] 33 34This command creates a new string channel and returns its handle. The 35channel provides random read-only access to the [arg content] string. 36 37[list_end] 38 39 40[section {BUGS, IDEAS, FEEDBACK}] 41 42This document, and the package it describes, will undoubtedly contain 43bugs and other problems. 44 45Please report such in the category [emph virtchannel] of the 46[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}]. 47 48Please also report any ideas for enhancements you may have for either 49package and/or documentation. 50 51 52[keywords {virtual channel} {reflected channel} {in-memory channel} {tip 219}] 53[manpage_end] 54