/usr/share/doc/tcl-memchan-dev/html/memchanapi.html

<html><head>
<title>memchan - 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/memchanapi.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2004 Pat Thoyts &lt;patthoyts@users.sourceforge.net&gt;
   -->
<! -- CVS: $Id$ memchan.n
   -->
<body><div class="doctools">
<h1 class="title">memchan(3tcl) 2.2  &quot;Memory channels&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>memchan - C API for creating memory 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="#section2">COMMAND</a></li>
<li class="section"><a href="#see-also">See Also</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">Tcl_Channel <b class="cmd">Memchan_CreateMemoryChannel</b> (<i class="arg">Tcl_Interp *interp</i>, <i class="arg">int initialSize</i>)</a></li>
<li><a href="#2">Tcl_Channel <b class="cmd">Memchan_CreateFifoChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></li>
<li><a href="#3">void <b class="cmd">Memchan_CreateFifo2Channel</b> (<i class="arg">Tcl_Interp *interp</i>, <i class="arg">Tcl_Channel *aPtr</i>, <i class="arg">Tcl_Channel *bPtr</i>)</a></li>
<li><a href="#4">Tcl_Channel <b class="cmd">Memchan_CreateNullChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></li>
<li><a href="#5">Tcl_Channel <b class="cmd">Memchan_CreateZeroChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></li>
<li><a href="#6">Tcl_Channel <b class="cmd">Memchan_CreateRandomChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>The <b class="package">memchan</b> package provides a C API for use by
third-party extension writers. This is exposed by a Tcl stubs library
table to reduce version dependency as is available for Tcl itself.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">COMMAND</a></h2>
<dl class="definitions">
<dt><a name="1">Tcl_Channel <b class="cmd">Memchan_CreateMemoryChannel</b> (<i class="arg">Tcl_Interp *interp</i>, <i class="arg">int initialSize</i>)</a></dt>
<dd></dd>
<dt><a name="2">Tcl_Channel <b class="cmd">Memchan_CreateFifoChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></dt>
<dd></dd>
<dt><a name="3">void <b class="cmd">Memchan_CreateFifo2Channel</b> (<i class="arg">Tcl_Interp *interp</i>, <i class="arg">Tcl_Channel *aPtr</i>, <i class="arg">Tcl_Channel *bPtr</i>)</a></dt>
<dd></dd>
<dt><a name="4">Tcl_Channel <b class="cmd">Memchan_CreateNullChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></dt>
<dd></dd>
<dt><a name="5">Tcl_Channel <b class="cmd">Memchan_CreateZeroChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></dt>
<dd></dd>
<dt><a name="6">Tcl_Channel <b class="cmd">Memchan_CreateRandomChannel</b> (<i class="arg">Tcl_Interp *interp</i>)</a></dt>
<dd></dd>
</dl>
<p>Each of these functions creates an returns a channel exactly as
described in the Tcl command pages for each of the <b class="package">memchan</b>
commands. The Tcl commands internally call these functions to create
the channels.</p>
<p>The <b class="cmd">memchan</b> channel accepts an <i class="arg">initialSize</i> argument to
permit pre-allocating space for the internal buffer. Normally this may
be set to 0.</p>
<p>The <b class="cmd">fifo2</b> API function looks a little different because it must
return two linked channels.</p>
</div>
<div id="see-also" class="section"><h2><a name="see-also">See Also</a></h2>
<p>Tcl_GetChannelName</p>
</div>
<div id="copyright" class="section"><h2><a name="copyright">Copyright</a></h2>
<p>Copyright &copy; 2004 Pat Thoyts &lt;patthoyts@users.sourceforge.net&gt;</p>
</div>
</div></body></html>
tcl-memchan-dev 2.3-2 / usr / share / doc / tcl-memchan-dev / html / memchanapi.html
