1[comment {-*- tcl -*- doctools manpage}]
2[manpage_begin tcl::chan::fifo n 1]
3[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
4[moddesc   {Reflected/virtual channel support}]
5[category  Channels]
6[titledesc {In-memory fifo channel}]
7[require Tcl 8.5]
8[require TclOO]
9[require tcl::chan::events [opt 1]]
10[require tcl::chan::fifo [opt 1]]
11[description]
12[para]
13
14The [package tcl::chan::fifo] package provides a command creating
15channels which live purely in memory. Access is fifo-like, i.e. things
16are read out of the channel in the order they were written to it.
17
18This is equivalent to the fifo channels provided by the package
19[package Mmechan], except that this is written in pure Tcl, not C. On
20the other hand, [package Memchan] is usable with Tcl 8.4 and before,
21whereas this package requires Tcl 8.5 or higher, and [package TclOO].
22
23[para] The internal [package TclOO] class implementing the channel
24handler is a sub-class of the [package tcl::chan::events] framework.
25
26[section API]
27
28[list_begin definitions]
29
30[call [cmd ::tcl::chan::fifo]]
31
32This command creates a new fifo channel and returns its handle.
33
34[list_end]
35
36
37[section {BUGS, IDEAS, FEEDBACK}]
38
39This document, and the package it describes, will undoubtedly contain
40bugs and other problems.
41
42Please report such in the category [emph virtchannel] of the
43[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}].
44
45Please also report any ideas for enhancements you may have for either
46package and/or documentation.
47
48[keywords fifo]
49[keywords {virtual channel} {reflected channel} {in-memory channel} {tip 219}]
50[manpage_end]
51