Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 1490

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XProtocolProperties</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="XProtocolProperties-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">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">bridge</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XProtocolProperties</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Bridge internal interface, that allows to change protocol settings of the remote
 counter part. 

 </dd>
<dd><p>In general, this interface is implemented by the bridge itself. It must not
 be called from outside the bridge.</p>

 <p>INTERNAL INTERFACE, DO NOT USE IT ELSEWHERE!</p>
</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="#getProperties">getProperties</a></td>
<td class="imsum_right">called to get a list of bridge internal properties. Which properties can be retrieved, 
 is protocol dependent.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#requestChange">requestChange</a></td>
<td class="imsum_right">called to initiate a protocol change. 

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#commitChange">commitChange</a></td>
<td class="imsum_right">called to commit a protocol change. 

 &nbsp;</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="getProperties" class="membertitle">getProperties</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">sequence&lt; <a href="ProtocolProperty.html">ProtocolProperty</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getProperties</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>called to get a list of bridge internal properties. Which properties can be retrieved, 
 is protocol dependent.
 
 </dd>
<dd><p> The properties MUST NOT change between a requestChange and a commit change call.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="requestChange" class="membertitle">requestChange</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>requestChange</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nRandomNumber );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>called to initiate a protocol change. 

 </dd>
<dd><p>This method should always be called in the scope of the local bridge setting object, 
 because the remote counter part may do such a call at the same time 
 (typically at startup time). </p>
 
 </dd>
<dt><b>Parameter nRandomNumber</b></dt>
<dd>In case both processes call requestChange at the same time,
 the caller with the higher nRandomNumber is allowed to call
 commitChange.

 </dd>
<dt><b>Returns</b></dt>
<dd>1, if the caller may ( and MUST !!!) call commitChange.
 0, if the caller is not allowed to call commitChange. This can only happen,
 if the other bridge has called requestChange at the same time and
 nRandomNumber is smaller than the other bridge's nRandomNumber.
 The remote counterpart is supposed to call commitChange within a small
 time span. Please call requestChange() after the remote counterpart has
 called commitChange().
 -1 if the nRandomNumber is of the same value as the previously
 sent requestChange (sent by the remote counterpart). This is a draw :o).
 Generate a new random number and try again.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="commitChange" class="membertitle">commitChange</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>commitChange</b>(</td>
<td valign="top">[in] sequence&lt; <a href="ProtocolProperty.html">ProtocolProperty</a> &gt;</td>
<td valign="bottom">&nbsp;newValues )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="InvalidProtocolChangeException.html">InvalidProtocolChangeException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>called to commit a protocol change. 

 </dd>
<dd><p>It is only allowed to call commitChange, if requestChange 
 has been called previously and the return value was true. The new properties are 
 valid after the reply of commitChange has been received.
 Note, that this is difficult for the callee, because it must marshal the reply
 with the old settings. </p>

 <p>All properties not mentioned in the list are unchanged.
 Note that the bridge must be blocked for other threads,
 before commitChange is sent and unblocked
 after the reply has been received. This blocks the bridge.</p>
 
 </dd>
<dt><b>Throws</b></dt>
<dd>InvalidProtocolChangeException
 when the remote counterpart could not change at least one of the properties. 
 No property has been changed. requestChange must be called
 again to initiate a new change of the protocol.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>