psionrevo
/
ccoms-html
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Upload files to "/"

This commit is contained in:
psionrevo 2024-09-26 19:20:03 +00:00
commit b4f50793e1
5 changed files with 1875 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
buffer.htm Normal file
View File

@ -0,0 +1,46 @@
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>Buffer Flags</title>
</head>
<body>
<h1>Buffer Flags</h1>
<hr>
<table border="1">
<tr>
<td><code>KCommBufferFull&amp;</code></td>
<td>Full buffering means that the comms server will
always attempt to allocate enough memory to satisfy any
reads or writes in a single copy.<p>When a port is opened,
the default is full buffering</p>
</td>
</tr>
<tr>
<td><code>KCommBufferPartial&amp;</code></td>
<td>Partial buffering means that the comms server will
allocate a static buffer and use partial copies to
transfer data to the serial driver. </td>
</tr>
</table>
<h5>Note</h5>
<p>The default of full buffering is nearly always going to be the
quicker option, as only a single client-server data transfer is
ever needed. The mode should not be changed by an application
without a very good reason (such as memory constraints) otherwise
performance is liable to suffer</p>
<h5>See Also</h5>
<p><a href="file:///P:/Opx/CComms/DOCUME~1/comm.htm#Mode">CommMode</a>,
<a href="file:///P:/Opx/CComms/DOCUME~1/comm.htm#SetMode">CommSetMode</a></p>
</body>
</html>

117
charsize.htm Normal file
View File

@ -0,0 +1,117 @@
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>Character size</title>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a
href="../Documentation/serialin.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="datarate.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
<hr>
<h1>Character size</h1>
<hr>
<h2><a name="Overview">Overview</a></h2>
<h5>Defined in</h5>
<p><code>ccomms.oxh</code></p>
<hr>
<table border="1">
<tr>
<td><code>KData5%</code></td>
<td>Only 5 bits are transmitted for each character in the
data stream</td>
</tr>
<tr>
<td><code>KData6%</code></td>
<td>Only 6 bits are transmitted for each character in the
data stream</td>
</tr>
<tr>
<td><code>KData7%</code></td>
<td>Only 7 bits are transmitted for each character in the
data stream</td>
</tr>
<tr>
<td><code>KData8%</code></td>
<td>All 8 bits are transmitted for each character in the
data stream</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="charsizecap.htm">Character size capabilities</a>, <a
href="commcfg1.htm#DataBits">CommConfigDataBits</a>, <a
href="commcfg1.htm#SetDataBits">CommConfigSetDataBits</a></p>
<hr>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a
href="../Documentation/serialin.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="datarate.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
</body>
</html>

110
charsizecap.htm Normal file
View File

@ -0,0 +1,110 @@
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>Character size capabilities</title>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a href="stopbits.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="dataratecap.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
<hr>
<h1>Character size capabilities</h1>
<hr>
<h2><a name="Overview">Overview</a></h2>
<h5>Defined in</h5>
<p><code>ccomms.oxh</code></p>
<hr>
<table border="1">
<tr>
<td><code>KCapsData5&amp;</code></td>
<td>The driver supports 5 bits per character</td>
</tr>
<tr>
<td><code>KCapsData6&amp;</code></td>
<td>The driver supports 6bits per character</td>
</tr>
<tr>
<td><code>KCapsData7&amp;</code></td>
<td>The driver supports 7bits per character</td>
</tr>
<tr>
<td><code>KCapsData8&amp;</code></td>
<td>The driver supports 8bits per character</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="charsize.htm">Character size constants</a>, <a
href="commcaps.htm#DataBits">CommCapsDataBits</a></p>
<hr>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a href="stopbits.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="dataratecap.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
</body>
</html>

1143
comm.htm Normal file
View File

File diff suppressed because it is too large Load Diff

459
commcaps.htm Normal file
View File

@ -0,0 +1,459 @@
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>CommCapsV01</title>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a href="comm.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="commcfg1.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
<hr>
<h1>CommCaps Class</h1>
<hr>
<p><em>Section contents</em></p>
<ul>
<li><a href="#Overview"><strong>Overview</strong></a></li>
<li><a href="#Construction"><strong>Construction /
destruction</strong></a><ul>
<li><a href="#NewServ"><strong>NewCommCaps -
Constructor</strong></a></li>
<li><a href="#DeleteComm"><strong>DeleteCommCaps -
Destructor</strong></a></li>
</ul>
</li>
<li><a href="#Methods provided"><strong>Methods provided</strong></a><ul>
<li><a href="#DataBits"><strong>CommCapsDataBits -
Number of data bits supported</strong></a></li>
<li><a href="#FIFO"><strong>CommCapsFIFO - FIFO
capabilities supported</strong></a></li>
<li><a href="#FIFO"><strong>CommCapsHandshake -
Handshaking capabilities supported</strong></a></li>
<li><a href="#FIFO"><strong>CommCapsParity - Parity
capabilities supported</strong></a></li>
<li><a href="#FIFO"><strong>CommCapsRate - Data Rate
capabilities supported</strong></a></li>
<li><a href="#FIFO"><strong>CommCapsSignals - Signal
capabilities supported</strong></a></li>
<li><a href="#FIFO"><strong>CommCapsSIR - SIR
capabilities supported</strong></a></li>
<li><a href="#StopBits"><strong>CommCapsStopBits -
Stop bits supported</strong></a></li>
</ul>
</li>
</ul>
<hr>
<h2><a name="Overview">Overview</a></h2>
<h5>Defined in</h5>
<p><code>ccomms.oxh</code></p>
<h5>Description</h5>
<p><code>CommCaps</code> represents the configuration
capabilities of a serial port.</p>
<h5>See Also</h5>
<p><a href="comm.htm#Caps">CommCaps</a></p>
<hr>
<h2><a name="Construction">Construction / destruction</a></h2>
<hr size="1">
<h3><a name="NewServ">NewCommCaps - Constructor</a></h3>
<h5>Usage</h5>
<p><code>this&amp; = NewCommCaps&amp;:</code></p>
<h5>Description</h5>
<p>Creates a CommCaps object and returns a handle which allows
the object to be manipulated.</p>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>An value which represents the created CommCaps object</td>
</tr>
</table>
<h5>Error Handling</h5>
<p>If the object could not be created then an error is generated
which should be trapped by an <font face="Times New Roman"><code>ONERR</code></font>
handler.</p>
<h5>Example</h5>
<pre> LOCAL this&amp;
<strong>this&amp; = NewCommCaps&amp;:</strong>
DeleteCommCaps:(this&amp;) </pre>
<hr size="1">
<h3><a name="DeleteComm">DeleteCommCaps - Destructor</a></h3>
<h5>Usage</h5>
<p><code>DeleteCommCaps:(BYREF this&amp;)</code></p>
<h5>Description</h5>
<p>Destroys the CommCaps object.</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>BYREF this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Example</h5>
<pre> LOCAL this&amp;
this&amp; = NewCommCaps&amp;:()
<strong>DeleteCommCaps:(this&amp;)</strong> </pre>
<hr>
<h2><a name="Methods provided">Methods provided</a></h2>
<hr size="1">
<h3><a name="DataBits">CommCapsDataBits - Number of Data Bits
supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsDataBits&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The number of <a
href="file:///P:/Opx/CComms/Documentation/charsizecap.htm">data
bits</a> supported</td>
</tr>
</table>
<hr size="1">
<h3><a name="FIFO">CommCapsFIFO - FIFO capabilities supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsFIFO&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The <a
href="file:///P:/Opx/CComms/Documentation/fifocap.htm">FIFO
capabilities</a> supported</td>
</tr>
</table>
<hr size="1">
<h3><a name="Handshake">CommCapsHandshake - Handshaking
capabilities supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsHandshake&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The <a
href="file:///P:/Opx/CComms/Documentation/handcap.htm">handshaking
capabilities</a> supported</td>
</tr>
</table>
<hr size="1">
<h3><a name="Parity">CommCapsParity - Parity capabilities
supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsParity&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The <a
href="file:///P:/Opx/CComms/Documentation/paritycap.htm">parity
capabilities</a> supported</td>
</tr>
</table>
<hr size="1">
<h3><a name="Rate">CommCapsRate - Data rate capabilities
supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsRate&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The <a href="../Documentation/dataratecap.htm">data
rate capabilities</a> supported</td>
</tr>
</table>
<hr size="1">
<h3><a name="Signals">CommCapsSignals - Signals capabilities
supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsSignals&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The <a href="../Documentation/signalcap.htm">signal
line capabilities</a> supported</td>
</tr>
</table>
<hr size="1">
<h3><a name="SIR">CommCapsSIR - SIR capabilities supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsSIR&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The <a
href="file:///P:/Opx/CComms/Documentation/serialcap.htm">SIR
capabilities</a></td>
</tr>
</table>
<hr size="1">
<h3><a name="StopBits">CommCapsStopBits - Stop bit capabilities
supported</a></h3>
<h5>Usage</h5>
<p><code>cap&amp; = CommCapsStopBits&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommCaps object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>caps&amp;</code></td>
<td>The <a
href="file:///P:/Opx/CComms/Documentation/stopbitcap.htm">Stop
bit capabilities</a></td>
</tr>
</table>
<hr>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a href="comm.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="commcfg1.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
</body>
</html>