Sophie

Sophie

distrib > Fedora > 13 > i386 > media > os > by-pkgid > 07dfcfe50d66c9a48a3c5e6c1693f12a > files > 2428

cryptopp-doc-5.6.1-0.1.svn479.fc13.i686.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crypto++: winpipes.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>winpipes.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef CRYPTOPP_WINPIPES_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define CRYPTOPP_WINPIPES_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &quot;config.h&quot;</span>
<a name="l00005"></a>00005 
<a name="l00006"></a>00006 <span class="preprocessor">#ifdef WINDOWS_PIPES_AVAILABLE</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &quot;network.h&quot;</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include &quot;queue.h&quot;</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include &lt;winsock2.h&gt;</span>
<a name="l00011"></a>00011 
<a name="l00012"></a>00012 NAMESPACE_BEGIN(CryptoPP)
<a name="l00013"></a>00013 
<a name="l00014"></a>00014 <span class="comment">//! Windows Handle</span>
<a name="l00015"></a><a class="code" href="class_windows_handle.html">00015</a> <span class="comment"></span>class <a class="code" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a>
<a name="l00016"></a>00016 {
<a name="l00017"></a>00017 <span class="keyword">public</span>:
<a name="l00018"></a>00018         WindowsHandle(HANDLE h = INVALID_HANDLE_VALUE, <span class="keywordtype">bool</span> own=<span class="keyword">false</span>);
<a name="l00019"></a>00019         WindowsHandle(<span class="keyword">const</span> WindowsHandle &amp;h) : m_h(h.m_h), m_own(<span class="keyword">false</span>) {}
<a name="l00020"></a>00020         <span class="keyword">virtual</span> ~WindowsHandle();
<a name="l00021"></a>00021 
<a name="l00022"></a>00022         <span class="keywordtype">bool</span> GetOwnership()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_own;}
<a name="l00023"></a>00023         <span class="keywordtype">void</span> SetOwnership(<span class="keywordtype">bool</span> own) {m_own = own;}
<a name="l00024"></a>00024 
<a name="l00025"></a>00025         operator HANDLE() {<span class="keywordflow">return</span> m_h;}
<a name="l00026"></a>00026         HANDLE GetHandle()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_h;}
<a name="l00027"></a>00027         <span class="keywordtype">bool</span> HandleValid() <span class="keyword">const</span>;
<a name="l00028"></a>00028         <span class="keywordtype">void</span> AttachHandle(HANDLE h, <span class="keywordtype">bool</span> own=<span class="keyword">false</span>);
<a name="l00029"></a>00029         HANDLE DetachHandle();
<a name="l00030"></a>00030         <span class="keywordtype">void</span> CloseHandle();
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">protected</span>:
<a name="l00033"></a>00033         <span class="keyword">virtual</span> <span class="keywordtype">void</span> HandleChanged() {}
<a name="l00034"></a>00034 
<a name="l00035"></a>00035         HANDLE m_h;
<a name="l00036"></a>00036         <span class="keywordtype">bool</span> m_own;
<a name="l00037"></a>00037 };
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">//! Windows Pipe</span>
<a name="l00040"></a><a class="code" href="class_windows_pipe.html">00040</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_windows_pipe.html" title="Windows Pipe.">WindowsPipe</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">public</span>:
<a name="l00043"></a><a class="code" href="class_windows_pipe_1_1_err.html">00043</a>         <span class="keyword">class </span><a class="code" href="class_windows_pipe_1_1_err.html">Err</a> : <span class="keyword">public</span> <a class="code" href="class_o_s___error.html" title="error reported by the operating system">OS_Error</a>
<a name="l00044"></a>00044         {
<a name="l00045"></a>00045         <span class="keyword">public</span>:
<a name="l00046"></a>00046                 <a class="code" href="class_windows_pipe_1_1_err.html">Err</a>(HANDLE h, <span class="keyword">const</span> std::string&amp; operation, <span class="keywordtype">int</span> error);
<a name="l00047"></a>00047                 HANDLE GetHandle()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_h;}
<a name="l00048"></a>00048 
<a name="l00049"></a>00049         <span class="keyword">private</span>:
<a name="l00050"></a>00050                 HANDLE m_h;
<a name="l00051"></a>00051         };
<a name="l00052"></a>00052 
<a name="l00053"></a>00053 <span class="keyword">protected</span>:
<a name="l00054"></a>00054         <span class="keyword">virtual</span> HANDLE GetHandle() <span class="keyword">const</span> =0;
<a name="l00055"></a>00055         <span class="keyword">virtual</span> <span class="keywordtype">void</span> HandleError(<span class="keyword">const</span> <span class="keywordtype">char</span> *operation) <span class="keyword">const</span>;
<a name="l00056"></a>00056         <span class="keywordtype">void</span> CheckAndHandleError(<span class="keyword">const</span> <span class="keywordtype">char</span> *operation, BOOL result)<span class="keyword"> const</span>
<a name="l00057"></a>00057 <span class="keyword">                </span>{assert(result==TRUE || result==FALSE); <span class="keywordflow">if</span> (!result) HandleError(operation);}
<a name="l00058"></a>00058 };
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment">//! pipe-based implementation of NetworkReceiver</span>
<a name="l00061"></a><a class="code" href="class_windows_pipe_receiver.html">00061</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_windows_pipe_receiver.html" title="pipe-based implementation of NetworkReceiver">WindowsPipeReceiver</a> : <span class="keyword">public</span> <a class="code" href="class_windows_pipe.html" title="Windows Pipe.">WindowsPipe</a>, <span class="keyword">public</span> <a class="code" href="class_network_receiver.html" title="Network Receiver.">NetworkReceiver</a>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 <span class="keyword">public</span>:
<a name="l00064"></a>00064         <a class="code" href="class_windows_pipe_receiver.html" title="pipe-based implementation of NetworkReceiver">WindowsPipeReceiver</a>();
<a name="l00065"></a>00065 
<a name="l00066"></a>00066         <span class="keywordtype">bool</span> MustWaitForResult() {<span class="keywordflow">return</span> <span class="keyword">true</span>;}
<a name="l00067"></a>00067         <span class="keywordtype">bool</span> <a class="code" href="class_windows_pipe_receiver.html#a97f6f63da2411395a55e416e0ea8b11b" title="receive data from network source, returns whether result is immediately available...">Receive</a>(byte* buf, <span class="keywordtype">size_t</span> bufLen);
<a name="l00068"></a>00068         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetReceiveResult();
<a name="l00069"></a>00069         <span class="keywordtype">bool</span> EofReceived()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_eofReceived;}
<a name="l00070"></a>00070 
<a name="l00071"></a><a class="code" href="class_windows_pipe_receiver.html#a9e251eb6961fd6ed48aae685e3cee419">00071</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_windows_pipe_receiver.html#a9e251eb6961fd6ed48aae685e3cee419" title="maximum number of wait objects that this object can return">GetMaxWaitObjectCount</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> 1;}
<a name="l00072"></a>00072         <span class="keywordtype">void</span> <a class="code" href="class_windows_pipe_receiver.html#a44a3dbb7ef3161d84731c3c320eaa33a" title="put wait objects into container">GetWaitObjects</a>(<a class="code" href="class_wait_object_container.html" title="container of wait objects">WaitObjectContainer</a> &amp;container, <a class="code" href="class_call_stack.html">CallStack</a> <span class="keyword">const</span>&amp; callStack);
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 <span class="keyword">private</span>:
<a name="l00075"></a>00075         <a class="code" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a> m_event;
<a name="l00076"></a>00076         OVERLAPPED m_overlapped;
<a name="l00077"></a>00077         <span class="keywordtype">bool</span> m_resultPending;
<a name="l00078"></a>00078         DWORD m_lastResult;
<a name="l00079"></a>00079         <span class="keywordtype">bool</span> m_eofReceived;
<a name="l00080"></a>00080 };
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">//! pipe-based implementation of NetworkSender</span>
<a name="l00083"></a><a class="code" href="class_windows_pipe_sender.html">00083</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_windows_pipe_sender.html" title="pipe-based implementation of NetworkSender">WindowsPipeSender</a> : <span class="keyword">public</span> <a class="code" href="class_windows_pipe.html" title="Windows Pipe.">WindowsPipe</a>, <span class="keyword">public</span> <a class="code" href="class_network_sender.html" title="Network Sender.">NetworkSender</a>
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 <span class="keyword">public</span>:
<a name="l00086"></a>00086         <a class="code" href="class_windows_pipe_sender.html" title="pipe-based implementation of NetworkSender">WindowsPipeSender</a>();
<a name="l00087"></a>00087 
<a name="l00088"></a>00088         <span class="keywordtype">bool</span> MustWaitForResult() {<span class="keywordflow">return</span> <span class="keyword">true</span>;}
<a name="l00089"></a>00089         <span class="keywordtype">void</span> Send(<span class="keyword">const</span> byte* buf, <span class="keywordtype">size_t</span> bufLen);
<a name="l00090"></a>00090         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetSendResult();
<a name="l00091"></a>00091         <span class="keywordtype">bool</span> MustWaitForEof() { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00092"></a>00092         <span class="keywordtype">void</span> SendEof() {}
<a name="l00093"></a>00093 
<a name="l00094"></a><a class="code" href="class_windows_pipe_sender.html#aa0341a587744e1861db4b2880fa40074">00094</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_windows_pipe_sender.html#aa0341a587744e1861db4b2880fa40074" title="maximum number of wait objects that this object can return">GetMaxWaitObjectCount</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> 1;}
<a name="l00095"></a>00095         <span class="keywordtype">void</span> <a class="code" href="class_windows_pipe_sender.html#a26b98ea160dc37248cb9934edb8a27ef" title="put wait objects into container">GetWaitObjects</a>(<a class="code" href="class_wait_object_container.html" title="container of wait objects">WaitObjectContainer</a> &amp;container, <a class="code" href="class_call_stack.html">CallStack</a> <span class="keyword">const</span>&amp; callStack);
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 <span class="keyword">private</span>:
<a name="l00098"></a>00098         <a class="code" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a> m_event;
<a name="l00099"></a>00099         OVERLAPPED m_overlapped;
<a name="l00100"></a>00100         <span class="keywordtype">bool</span> m_resultPending;
<a name="l00101"></a>00101         DWORD m_lastResult;
<a name="l00102"></a>00102 };
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment">//! Windows Pipe Source</span>
<a name="l00105"></a><a class="code" href="class_windows_pipe_source.html">00105</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_windows_pipe_source.html" title="Windows Pipe Source.">WindowsPipeSource</a> : <span class="keyword">public</span> <a class="code" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a>, <span class="keyword">public</span> <a class="code" href="class_network_source.html" title="Network Source.">NetworkSource</a>, <span class="keyword">public</span> <a class="code" href="class_windows_pipe_receiver.html" title="pipe-based implementation of NetworkReceiver">WindowsPipeReceiver</a>
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keyword">public</span>:
<a name="l00108"></a>00108         <a class="code" href="class_windows_pipe_source.html" title="Windows Pipe Source.">WindowsPipeSource</a>(HANDLE h=INVALID_HANDLE_VALUE, <span class="keywordtype">bool</span> pumpAll=<span class="keyword">false</span>, <a class="code" href="class_buffered_transformation.html" title="interface for buffered transformations">BufferedTransformation</a> *attachment=NULL)
<a name="l00109"></a>00109                 : <a class="code" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a>(h), <a class="code" href="class_network_source.html" title="Network Source.">NetworkSource</a>(attachment)
<a name="l00110"></a>00110         {
<a name="l00111"></a>00111                 <span class="keywordflow">if</span> (pumpAll)
<a name="l00112"></a>00112                         PumpAll();
<a name="l00113"></a>00113         }
<a name="l00114"></a>00114 
<a name="l00115"></a>00115         <a class="code" href="class_network_source.html#a4f8b5b536e6862529ba82c4efd2978ef">NetworkSource::GetMaxWaitObjectCount</a>;
<a name="l00116"></a>00116         NetworkSource::GetWaitObjects;
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="keyword">private</span>:
<a name="l00119"></a>00119         HANDLE GetHandle()<span class="keyword"> const </span>{<span class="keywordflow">return</span> WindowsHandle::GetHandle();}
<a name="l00120"></a>00120         <a class="code" href="class_network_receiver.html" title="Network Receiver.">NetworkReceiver</a> &amp; AccessReceiver() {<span class="keywordflow">return</span> *<span class="keyword">this</span>;}
<a name="l00121"></a>00121 };
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">//! Windows Pipe Sink</span>
<a name="l00124"></a><a class="code" href="class_windows_pipe_sink.html">00124</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_windows_pipe_sink.html" title="Windows Pipe Sink.">WindowsPipeSink</a> : <span class="keyword">public</span> <a class="code" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a>, <span class="keyword">public</span> <a class="code" href="class_network_sink.html" title="Network Sink.">NetworkSink</a>, <span class="keyword">public</span> <a class="code" href="class_windows_pipe_sender.html" title="pipe-based implementation of NetworkSender">WindowsPipeSender</a>
<a name="l00125"></a>00125 {
<a name="l00126"></a>00126 <span class="keyword">public</span>:
<a name="l00127"></a>00127         <a class="code" href="class_windows_pipe_sink.html" title="Windows Pipe Sink.">WindowsPipeSink</a>(HANDLE h=INVALID_HANDLE_VALUE, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxBufferSize=0, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> autoFlushBound=16*1024)
<a name="l00128"></a>00128                 : <a class="code" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a>(h), <a class="code" href="class_network_sink.html" title="Network Sink.">NetworkSink</a>(maxBufferSize, autoFlushBound) {}
<a name="l00129"></a>00129 
<a name="l00130"></a>00130         <a class="code" href="class_network_sink.html#a4c1ccafa0cd1eb8ea8eebf8dbdbcda29">NetworkSink::GetMaxWaitObjectCount</a>;
<a name="l00131"></a>00131         NetworkSink::GetWaitObjects;
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 <span class="keyword">private</span>:
<a name="l00134"></a>00134         HANDLE GetHandle()<span class="keyword"> const </span>{<span class="keywordflow">return</span> WindowsHandle::GetHandle();}
<a name="l00135"></a>00135         <a class="code" href="class_network_sender.html" title="Network Sender.">NetworkSender</a> &amp; AccessSender() {<span class="keywordflow">return</span> *<span class="keyword">this</span>;}
<a name="l00136"></a>00136 };
<a name="l00137"></a>00137 
<a name="l00138"></a>00138 NAMESPACE_END
<a name="l00139"></a>00139 
<a name="l00140"></a>00140 <span class="preprocessor">#endif</span>
<a name="l00141"></a>00141 <span class="preprocessor"></span>
<a name="l00142"></a>00142 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional