channel_8h-source.html

pwlib开发文档

00520     BOOL <a class="code" href="classPChannel.html#z51_5">WriteString</a>(<span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> &amp; str);
00521 
00531     <span class="keyword">virtual</span> BOOL <a class="code" href="classPChannel.html#z51_6">WriteAsync</a>(
00532       <span class="keyword">const</span> <span class="keywordtype">void</span> * buf, 
00533       PINDEX len        
00534     );
00535 
00541     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPChannel.html#z51_7">OnWriteComplete</a>(
00542       <span class="keyword">const</span> <span class="keywordtype">void</span> * buf, 
00543       PINDEX len        
00544     );
00546 
00553     <span class="keyword">virtual</span> BOOL <a class="code" href="classPChannel.html#z53_1">Close</a>();
00554 
<a name="l00555"></a><a class="code" href="classPChannel.html#z53_0">00555</a>     <span class="keyword">enum</span> <a class="code" href="classPChannel.html#z53_0">ShutdownValue</a> {
00556       <a class="code" href="classPChannel.html#z53_0s0">ShutdownRead</a>         = 0,
00557       <a class="code" href="classPChannel.html#z53_0s1">ShutdownWrite</a>        = 1,
00558       <a class="code" href="classPChannel.html#z53_0s2">ShutdownReadAndWrite</a> = 2
00559     };
00560 
00568     <span class="keyword">virtual</span> BOOL <a class="code" href="classPChannel.html#z53_2">Shutdown</a>(
00569       <a class="code" href="classPChannel.html#z53_0">ShutdownValue</a> option
00570     );
00571 
00577     BOOL <a class="code" href="classPChannel.html#z53_3">SetBufferSize</a>(
00578       PINDEX newSize    
00579     );
00580 
00620     BOOL <a class="code" href="classPChannel.html#z53_4">SendCommandString</a>(
00621       <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> &amp; command  
00622     );
00623 
00628     <span class="keywordtype">void</span> <a class="code" href="classPChannel.html#z53_5">AbortCommandString</a>();
00630 
<a name="l00636"></a><a class="code" href="classPChannel.html#z55_0">00636</a>     <span class="keyword">enum</span> <a class="code" href="classPChannel.html#z55_0">Errors</a> {
00637       <a class="code" href="classPChannel.html#z55_0s3">NoError</a>,
00639       <a class="code" href="classPChannel.html#z55_0s4">NotFound</a>,       
00641       <a class="code" href="classPChannel.html#z55_0s5">FileExists</a>,     
00643       <a class="code" href="classPChannel.html#z55_0s6">DiskFull</a>,       
00645       <a class="code" href="classPChannel.html#z55_0s7">AccessDenied</a>,   
00647       <a class="code" href="classPChannel.html#z55_0s8">DeviceInUse</a>,    
00649       <a class="code" href="classPChannel.html#z55_0s9">BadParameter</a>,   
00651       <a class="code" href="classPChannel.html#z55_0s10">NoMemory</a>,       
00653       <a class="code" href="classPChannel.html#z55_0s11">NotOpen</a>,        
00655       <a class="code" href="classPChannel.html#z55_0s12">Timeout</a>,        
00657       <a class="code" href="classPChannel.html#z55_0s13">Interrupted</a>,    
00659       <a class="code" href="classPChannel.html#z55_0s14">BufferTooSmall</a>, 
00661       <a class="code" href="classPChannel.html#z55_0s15">Miscellaneous</a>,
00663       <a class="code" href="classPChannel.html#z55_0s16">ProtocolFailure</a>,
00664       <a class="code" href="classPChannel.html#z55_0s17">NumNormalisedErrors</a>
00665     };
00666 
<a name="l00672"></a><a class="code" href="classPChannel.html#z55_1">00672</a>     <span class="keyword">enum</span> <a class="code" href="classPChannel.html#z55_1">ErrorGroup</a> {
00673       <a class="code" href="classPChannel.html#z55_1s18">LastReadError</a>,      
00674       <a class="code" href="classPChannel.html#z55_1s19">LastWriteError</a>,     
00675       <a class="code" href="classPChannel.html#z55_1s20">LastGeneralError</a>,   
00676       <a class="code" href="classPChannel.html#z55_1s21">NumErrorGroups</a>
00677     };
00678 
00683     <a class="code" href="classPChannel.html#z55_0">Errors</a> <a class="code" href="classPChannel.html#z55_2">GetErrorCode</a>(
00684       <a class="code" href="classPChannel.html#z55_1">ErrorGroup</a> group = <a class="code" href="classPChannel.html#z55_1s21">NumErrorGroups</a>   
00685     ) <span class="keyword">const</span>;
00686 
00692     <span class="keywordtype">int</span> <a class="code" href="classPChannel.html#z55_3">GetErrorNumber</a>(
00693       <a class="code" href="classPChannel.html#z55_1">ErrorGroup</a> group = <a class="code" href="classPChannel.html#z55_1s21">NumErrorGroups</a>   
00694     ) <span class="keyword">const</span>;
00695 
00701     <span class="keyword">virtual</span> <a class="code" href="classPString.html">PString</a> <a class="code" href="classPChannel.html#z55_4">GetErrorText</a>(
00702       <a class="code" href="classPChannel.html#z55_1">ErrorGroup</a> group = <a class="code" href="classPChannel.html#z55_1s21">NumErrorGroups</a>   
00703     ) <span class="keyword">const</span>;
00704 
00711     <span class="keyword">static</span> <a class="code" href="classPString.html">PString</a> <a class="code" href="classPChannel.html#z55_4">GetErrorText</a>(
00712       <a class="code" href="classPChannel.html#z55_0">Errors</a> lastError,   
00713       <span class="keywordtype">int</span> osError = 0     
00714     );
00716 
00723     <span class="keyword">static</span> BOOL <a class="code" href="classPChannel.html#d0">ConvertOSError</a>(
00724       <span class="keywordtype">int</span> libcReturnValue,
00725       <a class="code" href="classPChannel.html#z55_0">Errors</a> &amp; lastError,
00726       <span class="keywordtype">int</span> &amp; osError
00727     );
00728 
00729 
00730   <span class="keyword">protected</span>:
00731     <a class="code" href="classPChannel.html#z43_0">PChannel</a>(<span class="keyword">const</span> <a class="code" href="classPChannel.html">PChannel</a> &amp;);
00732     <a class="code" href="classPChannel.html">PChannel</a> &amp; <a class="code" href="classPChannel.html#b1">operator=</a>(<span class="keyword">const</span> <a class="code" href="classPChannel.html">PChannel</a> &amp;);
00733     <span class="comment">// Prevent usage by external classes</span>
00734 
00735 
00742     <span class="keyword">virtual</span> BOOL <a class="code" href="classPChannel.html#d0">ConvertOSError</a>(
00743       <span class="keywordtype">int</span> libcReturnValue,
00744       <a class="code" href="classPChannel.html#z55_1">ErrorGroup</a> group = <a class="code" href="classPChannel.html#z55_1s20">LastGeneralError</a> 
00745     );
00746 
00750     BOOL <a class="code" href="classPChannel.html#b3">SetErrorValues</a>(
00751       <a class="code" href="classPChannel.html#z55_0">Errors</a> errorCode,   
00752       <span class="keywordtype">int</span> osError,        
00753       <a class="code" href="classPChannel.html#z55_1">ErrorGroup</a> group = <a class="code" href="classPChannel.html#z55_1s20">LastGeneralError</a> 
00754     );
00755 
00764     <span class="keywordtype">int</span> <a class="code" href="classPChannel.html#b4">ReadCharWithTimeout</a>(
00765       <a class="code" href="classPTimeInterval.html">PTimeInterval</a> &amp; timeout  <span class="comment">// Timeout for read.</span>
00766     );
00767 
00768     <span class="comment">// Receive a (partial) command string, determine if completed yet.</span>
00769     BOOL <a class="code" href="classPChannel.html#b5">ReceiveCommandString</a>(
00770       <span class="keywordtype">int</span> nextChar,
00771       <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> &amp; reply,
00772       PINDEX &amp; pos,
00773       PINDEX start
00774     );
00775 
00776 
00777     <span class="comment">// Member variables</span>
<a name="l00779"></a><a class="code" href="classPChannel.html#n0">00779</a> <span class="comment">    int os_handle;</span>
<a name="l00781"></a><a class="code" href="classPChannel.html#n1">00781</a> <span class="comment">    Errors lastErrorCode[NumErrorGroups+1];</span>
<a name="l00783"></a><a class="code" href="classPChannel.html#n2">00783</a> <span class="comment">    int lastErrorNumber[NumErrorGroups+1];</span>
<a name="l00785"></a><a class="code" href="classPChannel.html#n3">00785</a> <span class="comment">    PINDEX lastReadCount;</span>
<a name="l00787"></a><a class="code" href="classPChannel.html#n4">00787</a> <span class="comment">    PINDEX lastWriteCount;</span>
<a name="l00789"></a><a class="code" href="classPChannel.html#n5">00789</a> <span class="comment">    PTimeInterval readTimeout;</span>
<a name="l00791"></a><a class="code" href="classPChannel.html#n6">00791</a> <span class="comment">    PTimeInterval writeTimeout;</span>
00792 
00793 
00794   <span class="keyword">private</span>:
00795     <span class="comment">// New functions for class</span>
00796     <span class="keywordtype">void</span> Construct();
00797       <span class="comment">// Complete platform dependent construction.</span>
00798 
00799     <span class="comment">// Member variables</span>
00800     BOOL abortCommandString;
00801       <span class="comment">// Flag to abort the transmission of a command in SendCommandString().</span>
00802 
00803 
00804 <span class="comment">// Include platform dependent part of class</span>
00805 <span class="preprocessor">#ifdef _WIN32</span>
00806 <span class="preprocessor"></span><span class="preprocessor">#include "msos/ptlib/channel.h"</span>
00807 <span class="preprocessor">#else</span>
00808 <span class="preprocessor"></span><span class="preprocessor">#include "unix/ptlib/channel.h"</span>
00809 <span class="preprocessor">#endif</span>
00810 <span class="preprocessor"></span>
00811 };
00812 
00813 <span class="preprocessor">#endif</span>
00814 <span class="preprocessor"></span>
00815 <span class="comment">// End Of File ///////////////////////////////////////////////////////////////</span>
</pre></div><hr><address style="align: right;"><small>Generated on Wed Sep 29 22:44:10 2004 for PWLib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>