<html> <head> <title>Interface XConnection</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XConnection-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">connection</a> :: </p> </td> </tr> <tr> <td class="title">interface XConnection</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>A bidirectional bytestream. </dd> <dd><p> You should additionally implement XConnection2. </dd> <dt><b>See also</b></dt> <dd><a href="XConnection2.html">XConnection2</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#read">read</a></td> <td class="imsum_right">reads a requested number of bytes from the connection. </td> </tr> <tr> <td class="imsum_left"><a href="#write">write</a></td> <td class="imsum_right">writes the given bytesequence to the stream. </td> </tr> <tr> <td class="imsum_left"><a href="#flush">flush</a></td> <td class="imsum_right">Empties all internal buffers. </td> </tr> <tr> <td class="imsum_left"><a href="#close">close</a></td> <td class="imsum_right">Immediately terminates any ongoing read or write calls. All subsequent read or write calls() </td> </tr> <tr> <td class="imsum_left"><a href="#getDescription">getDescription</a></td> <td class="imsum_right">A unique string describing the connection. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="read" class="membertitle">read</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>read</b>(</td> <td valign="top">[out] sequence< byte ></td> <td valign="bottom"> aReadBytes,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nBytesToRead )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>reads a requested number of bytes from the connection. </dd> <dd><p> This method is blocking, meaning that it always returns a bytesequence with the requested number of bytes, unless it has reached end of file (which often means, that close() has been called). <p> please see also the readSomeBytes() method of XConnection2. </dd> <dt><b>Returns</b></dt> <dd>The read number of bytes. The return value and the length of the returned sequence must be identical. </dd> <dt><b>Parameter nBytesToRead</b></dt> <dd>The number of bytes to be read from the stream. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException in case an error occurred during reading from the stream. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="write" class="membertitle">write</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>write</b>(</td> <td valign="top">[in] sequence< byte ></td> <td valign="bottom"> aData )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>writes the given bytesequence to the stream. </dd> <dd><p>The method blocks until the whole sequence is written. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException in case an error occurred during writing to the stream. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="flush" class="membertitle">flush</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>flush</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Empties all internal buffers. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="close" class="membertitle">close</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>close</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Immediately terminates any ongoing read or write calls. All subsequent read or write calls() </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDescription" class="membertitle">getDescription</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDescription</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>A unique string describing the connection. </dd> <dd><p>This string is different from the arguments to <a href="XConnection.html">XConnection</a>::<a href="XConnection.html#accept">accept</a> and <a href="XConnector.html">XConnector</a>::<a href="XConnector.html#connect">connect</a>. In general, the string contains an additional handle value. For example, "socket,host=localhost,port=2002,uniqueValue=2324". </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2112
