/usr/share/doc/libmemchan-tcl/html/fifo2.html is in libmemchan-tcl 2.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | <html><head>
<title>fifo2 - Memory channels</title>
<style type="text/css"><!--
HTML {
background: #FFFFFF;
color: black;
}
BODY {
background: #FFFFFF;
color: black;
}
DIV.doctools {
margin-left: 10%;
margin-right: 10%;
}
DIV.doctools H1,DIV.doctools H2 {
margin-left: -5%;
}
H1, H2, H3, H4 {
margin-top: 1em;
font-family: sans-serif;
font-size: large;
color: #005A9C;
background: transparent;
text-align: left;
}
H1.title {
text-align: center;
}
UL,OL {
margin-right: 0em;
margin-top: 3pt;
margin-bottom: 3pt;
}
UL LI {
list-style: disc;
}
OL LI {
list-style: decimal;
}
DT {
padding-top: 1ex;
}
UL.toc,UL.toc UL, UL.toc UL UL {
font: normal 12pt/14pt sans-serif;
list-style: none;
}
LI.section, LI.subsection {
list-style: none;
margin-left: 0em;
text-indent: 0em;
padding: 0em;
}
PRE {
display: block;
font-family: monospace;
white-space: pre;
margin: 0%;
padding-top: 0.5ex;
padding-bottom: 0.5ex;
padding-left: 1ex;
padding-right: 1ex;
width: 100%;
}
PRE.example {
color: black;
background: #f5dcb3;
border: 1px solid black;
}
UL.requirements LI, UL.syntax LI {
list-style: none;
margin-left: 0em;
text-indent: 0em;
padding: 0em;
}
DIV.synopsis {
color: black;
background: #80ffff;
border: 1px solid black;
font-family: serif;
margin-top: 1em;
margin-bottom: 1em;
}
UL.syntax {
margin-top: 1em;
border-top: 1px solid black;
}
UL.requirements {
margin-bottom: 1em;
border-bottom: 1px solid black;
}
--></style>
</head>
<! -- Generated from file './doc/fifo2.man' by tcllib/doctools with format 'html'
-->
<! -- Copyright © 1996-2003 Andreas Kupries <andreas_kupries@users.sourceforge.net>
-->
<! -- CVS: $Id$ fifo2.n
-->
<body><div class="doctools">
<h1 class="title">fifo2(3tcl) 2.2 "Memory channels"</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>fifo2 - Create and manipulate pipe fifo channels</p>
</div>
<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="toc">
<li class="section"><a href="#toc">Table Of Contents</a></li>
<li class="section"><a href="#synopsis">Synopsis</a></li>
<li class="section"><a href="#section1">Description</a></li>
<li class="section"><a href="#see-also">See Also</a></li>
<li class="section"><a href="#keywords">Keywords</a></li>
<li class="section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="synopsis">
<ul class="requirements">
<li>package require <b class="pkgname">Tcl</b></li>
<li>package require <b class="pkgname">memchan</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">fifo2</b></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>The command described here is only available in a not-yet released
version of the package. Use the CVS to get the sources.</p>
<dl class="definitions">
<dt><a name="1"><b class="cmd">fifo2</b></a></dt>
<dd><p>creates two stream-oriented in-memory channels and returns their
handles as a two-element list. There is no restriction on the ultimate
size of the channels, they will always grow as much as is necessary to
accommodate the data written into them.</p>
<p>In contrast to the channels generated by <b class="cmd">fifo</b> a pair of channels
created here is connected internally in such a way that data written
into one channel can be read from the other. All data written into
them is read in the same order. This also means that the two channels
of the pair are not seekable.</p>
<p>The channels created here can be transferred between interpreters in
the same thread and between threads. As both channels in the pair can
be transferred independently they can be used to create a bidirectional
connection between two interpreters.</p></dd>
</dl>
<p>Memory channels created by <b class="cmd">fifo2</b> provide two read-only options
which can be queried via the standard <b class="cmd">fconfigure</b> command. These
are</p>
<dl class="definitions">
<dt>-rlength</dt>
<dd><p>The value of this option is the number of bytes currently
available for reading from the channel.</p></dd>
<dt>-wlength</dt>
<dd><p>The value of this option is the number of bytes currently
written into the channel.</p></dd>
</dl>
<p>Note that the two lengths are switched for the channels of a pair. In
other words, the number of bytes written for one of the channels is
the number of bytes readable from the other end.</p>
<p>As the channels generated by <b class="cmd">fifo2</b> grow as necessary they are
always writable. This means that a writable <b class="cmd">fileevent</b>-handler
will fire continuously.</p>
<p>The channels are also readable if they contain more than zero
bytes. Under this conditions a readable <b class="cmd">fileevent</b>-handler will
fire continuously.</p>
</div>
<div id="see-also" class="section"><h2><a name="see-also">See Also</a></h2>
<p>fifo, memchan, null</p>
</div>
<div id="keywords" class="section"><h2><a name="keywords">Keywords</a></h2>
<p>channel, fifo, i/o, in-memory channel, memchan, stream</p>
</div>
<div id="copyright" class="section"><h2><a name="copyright">Copyright</a></h2>
<p>Copyright © 1996-2003 Andreas Kupries <andreas_kupries@users.sourceforge.net></p>
</div>
</div></body></html>
|