tcl::chan::string - Reflected/virtual channel support

[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# tcl::chan::string(n) 1.0.3 tcllib "Reflected/virtual channel support"

## Name

tcl::chan::string - Read-only in-memory channel

## Synopsis

- package require Tcl 8.5
- package require TclOO
- package require tcl::chan::events ?1?
- package require tcl::chan::string ?1.0.3?

- ::tcl::chan::string content

## Description

The 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 tcl::chan::memchan they are read-only however, their content is provided at the time of construction and immutable afterward.

Packages related to this are tcl::chan::memchan and tcl::chan::variable.

The internal TclOO class implementing the channel handler is a sub-class of the tcl::chan::events framework.

## API

::tcl::chan::string content

  This command creates a new string channel and returns its handle. The channel provides random read-only access to the content string.

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category virtchannel of the Tcllib Trackers. 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 output 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 © 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>