tcl::transform::identity - Reflected/virtual channel support

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

# tcl::transform::identity(n) 1 tcllib "Reflected/virtual channel support"

## Name

tcl::transform::identity - Identity transformation

## Synopsis

- package require Tcl 8.6
- package require tcl::transform::core ?1?
- package require tcl::transform::identity ?1?

- ::tcl::transform::identity chan

## Description

The tcl::transform::identity package provides a command creating an identity channel transformation, which does nothing but pass the read and written bytes through it unchanged. Not really useful in an application, however as the prototypical observer transformation its code is a useful starting point for any other observers people may wish to write.

The transformations in this module which derived from identity's code are tcl::transform::adler32, tcl::transform::counter, tcl::transform::crc32, and tcl::transform::observe.

The internal TclOO class implementing the transform handler is a sub-class of the tcl::transform::core framework.

## API

::tcl::transform::identity chan

  This command creates an identity transformation on top of the channel chan and returns its handle.

## 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

channel transformation, identity, reflected channel, tip 230, transformation, virtual channel

## Category

Channels

## Copyright

Copyright © 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>