trusty (3) limitsize.3tcl.gz

Provided by: tcllib_1.15-dfsg-2_all bug

NAME
       tcl::transform::limitsize - limiting input


SYNOPSIS
       package require Tcl  8.6

       package require tcl::transform::core  ?1?

       package require tcl::transform::limitsize  ?1?

       ::tcl::transform::limitsize chan max

_________________________________________________________________


DESCRIPTION
       The  tcl::transform::limitsize  package provides a command creating a channel transformation which limits
       the number of characters which can be read from the channel. A generator for an artificial EOF.

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


API
       ::tcl::transform::limitsize chan max
              This  command  creates  a  size limiting transformation on top of the channel chan and returns its
              handle.

              max is the number of bytes which can be read from the  channel  before  EOF  is  signaled  by  the
              transformation. Note that popping the transformation clears the EOF it generated as well.


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     SF     Trackers
       [http://sourceforge.net/tracker/?group_id=12883].   Please also report any ideas for enhancements you may
       have for either package and/or documentation.


KEYWORDS
       channel transformation, limitsize, reflected  channel,  size  limit,  tip  230,  transformation,  virtual
       channel


CATEGORY
       Channels


       Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>