<html> <head> <title>Methods of Class StreamPipe</title> <link rel="stylesheet" type="text/css" href="../../../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../../../index.html">Overview</a> </td> <td class="navimain"> <a href="../index.html">Namespace</a> </td> <td class="navimain"> <a href="../c-StreamPipe.html">Class</a> </td> <td class="navimain"> <a href="../../../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../../../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"></table> <hr> <div class="title"><h2>Methods of Class StreamPipe</h2> </div><hr> <dl class="member"> <dt class="member"><a name="StreamPipe-475"> </a>StreamPipe</dt> <dd class="member"><dl> <dt class="simple"> <strong>StreamPipe</strong>();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Description</dt> <dd>Creates an unattached pipe. You must attach the pipe to an oslPipe e.g. by using the operator=(oslPipe), before you can use the stream- functionality of the object. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="StreamPipe-476"> </a>StreamPipe</dt> <dd class="member"><dl> <dt class="simple"> <strong>StreamPipe</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="../../t-oslPipe.html">oslPipe</a> </td> <td> Pipe );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Creates pipe as wrapper around the underlying oslPipe. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">Pipe</td> <td><pre/></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="StreamPipe-477"> </a>StreamPipe</dt> <dd class="member"><dl> <dt class="simple"> <strong>StreamPipe</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="../../osl/c-StreamPipe.html">StreamPipe</a> & </td> <td> Pipe );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Copy constructor. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">Pipe</td> <td><pre/></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="StreamPipe-478"> </a>StreamPipe</dt> <dd class="member"><dl> <dt class="simple"> <strong>StreamPipe</strong>(</dt> <dd><table class="param-table"> <tr> <td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> & </td> <td> strName,</td> </tr> <tr> <td><a href="../../t-oslPipeOptions.html">oslPipeOptions</a></td> <td>Options = osl_Pipe_OPEN );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Creates a pipe. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">strName</td> <td><pre/></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">Options</td> <td><pre/></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="StreamPipe-479"> </a>StreamPipe</dt> <dd class="member"><dl> <dt class="simple"> <strong>StreamPipe</strong>(</dt> <dd><table class="param-table"> <tr> <td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> & </td> <td> strName,</td> </tr> <tr> <td><a href="../../t-oslPipeOptions.html">oslPipeOptions</a></td> <td>Options,</td> </tr> <tr> <td>const <a href="../../osl/c-Security.html">Security</a> &</td> <td>rSec );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Creates a pipe. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">strName</td> <td><pre/></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">Options</td> <td><pre/></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">rSec</td> <td><pre/></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="StreamPipe-480"> </a>StreamPipe</dt> <dd class="member"><dl> <dt class="simple"> <strong>StreamPipe</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="../../t-oslPipe.html">oslPipe</a> </td> <td> pipe,</td> </tr> <tr> <td><a href="../../e-__sal_NoAcquire.html">__sal_NoAcquire</a></td> <td>noacquire );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Constructs a Pipe reference without acquiring the handle </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="operator=-481"> </a>operator=</dt> <dd class="member"><dl> <dt class="simple"><a href="../../osl/c-StreamPipe.html">StreamPipe</a> & <strong>operator=</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="../../t-oslPipe.html">oslPipe</a> </td> <td> Pipe );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Description</dt> <dd>Attaches the oslPipe to this object. If the object already was attached to an oslPipe, the old one will be closed and destroyed. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">Pipe.</td> <td><pre/></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="operator=-482"> </a>operator=</dt> <dd class="member"><dl> <dt class="simple"><a href="../../osl/c-StreamPipe.html">StreamPipe</a> & <strong>operator=</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="../../osl/c-Pipe.html">Pipe</a> & </td> <td> pipe );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Assignment operator </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="recv-483"> </a>recv</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Int32.html">sal_Int32</a> <strong>recv</strong>(</dt> <dd><table class="param-table"> <tr> <td>void * </td> <td> pBuffer,</td> </tr> <tr> <td><a href="../../t-sal_Int32.html">sal_Int32</a></td> <td>BytesToRead ) const;</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Tries to receives BytesToRead data from the connected pipe, </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td> <td><pre>Points to a buffer that will be filled with the received data. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">BytesToRead</td> <td><pre>The number of bytes to read. pBuffer must have at least this size. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd>the number of received bytes. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="send-484"> </a>send</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Int32.html">sal_Int32</a> <strong>send</strong>(</dt> <dd><table class="param-table"> <tr> <td>const void * </td> <td> pBuffer,</td> </tr> <tr> <td><a href="../../t-sal_Int32.html">sal_Int32</a></td> <td>BytesToSend ) const;</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Tries to sends BytesToSend data from the connected pipe. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td> <td><pre>Points to a buffer that contains the send-data. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">BytesToSend</td> <td><pre>The number of bytes to send. pBuffer must have at least this size. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd>the number of transfered bytes. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="read-485"> </a>read</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Int32.html">sal_Int32</a> <strong>read</strong>(</dt> <dd><table class="param-table"> <tr> <td>void * </td> <td> pBuffer,</td> </tr> <tr> <td><a href="../../t-sal_Int32.html">sal_Int32</a></td> <td>n ) const;</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Retrieves n bytes from the stream and copies them into pBuffer. The method avoids incomplete reads due to packet boundaries. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td> <td><pre>receives the read data. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">n</td> <td><pre>the number of bytes to read. pBuffer must be large enough to hold the n bytes! </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd>the number of read bytes. The number will only be smaller than n if an exceptional condition (e.g. connection closed) occurs. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="write-486"> </a>write</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Int32.html">sal_Int32</a> <strong>write</strong>(</dt> <dd><table class="param-table"> <tr> <td>const void * </td> <td> pBuffer,</td> </tr> <tr> <td><a href="../../t-sal_Int32.html">sal_Int32</a></td> <td>n ) const;</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Writes n bytes from pBuffer to the stream. The method avoids incomplete writes due to packet boundaries. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td> <td><pre>contains the data to be written. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">n</td> <td><pre>the number of bytes to write. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd>the number of written bytes. The number will only be smaller than n if an exceptional condition (e.g. connection closed) occurs. </dd> </dl> </dd> </dl> <hr> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-cppref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
9198
