diff options
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/session/remote/CDORemoteSession.html')
| -rw-r--r-- | plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/session/remote/CDORemoteSession.html | 132 |
1 files changed, 77 insertions, 55 deletions
diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/session/remote/CDORemoteSession.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/session/remote/CDORemoteSession.html index 1b9ec011cb..6e1aa13dc2 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/session/remote/CDORemoteSession.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/session/remote/CDORemoteSession.html @@ -6,21 +6,34 @@ <title>CDORemoteSession (CDO Model Repository Documentation)</title> <meta name="date" content=""> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CDORemoteSession (CDO Model Repository Documentation)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CDORemoteSession (CDO Model Repository Documentation)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionEvent.html" title="interface in org.eclipse.emf.cdo.session.remote"><span class="strong">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionEvent.html" title="interface in org.eclipse.emf.cdo.session.remote"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/eclipse/emf/cdo/session/remote/CDORemoteSession.html" target="_top">Frames</a></li> -<li><a href="CDORemoteSession.html" target="_top">No Frames</a></li> +<li><a href="CDORemoteSession.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -101,17 +114,19 @@ </dl> <hr> <br> -<pre>public interface <span class="strong">CDORemoteSession</span> +<pre>public interface <span class="typeNameLabel">CDORemoteSession</span> extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html" title="interface in org.eclipse.emf.cdo.session.remote">CDORemoteSession</a>></pre> <div class="block">Represents a remote session that is connected to the same repository as the - <a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionManager.html#getLocalSession()"><code>local session</code></a> that the <a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getManager()"><code>remote session manager</code></a> + <a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionManager.html#getLocalSession--"><code>local session</code></a> that the <a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getManager--"><code>remote session manager</code></a> points to.</div> -<dl><dt><span class="strong">Since:</span></dt> - <dd>2.0</dd> -<dt><span class="strong">No Implement</span></dt> - <dd>This interface is not intended to be implemented by clients.</dd> -<dt><span class="strong">No Extend</span></dt> - <dd>This interface is not intended to be extended by clients.</dd></dl> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.0</dd> +<dt><span class="simpleTagLabel">No Implement</span></dt> +<dd>This interface is not intended to be implemented by clients.</dd> +<dt><span class="simpleTagLabel">No Extend</span></dt> +<dd>This interface is not intended to be extended by clients.</dd> +</dl> </li> </ul> </div> @@ -120,54 +135,54 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionManager.html" title="interface in org.eclipse.emf.cdo.session.remote">CDORemoteSessionManager</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getManager()">getManager</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getManager--">getManager</a></span>()</code> <div class="block">Returns the remote session manager that manages this remote session.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getSessionID()">getSessionID</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getSessionID--">getSessionID</a></span>()</code> <div class="block">Returns the session ID of this remote session.</div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getUserID()">getUserID</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#getUserID--">getUserID</a></span>()</code> <div class="block">Returns the user ID of this remote session.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#isSubscribed()">isSubscribed</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#isSubscribed--">isSubscribed</a></span>()</code> <div class="block">Returns <code>true</code> if this remote session is subscribed to changes in the set of remote sessions and delivers <a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionEvent.MessageReceived.html" title="interface in org.eclipse.emf.cdo.session.remote"><code>custom data events</code></a>, <code>false</code> otherwise.</div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#sendMessage(org.eclipse.emf.cdo.session.remote.CDORemoteSessionMessage)">sendMessage</a></strong>(<a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionMessage.html" title="class in org.eclipse.emf.cdo.session.remote">CDORemoteSessionMessage</a> message)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#sendMessage-org.eclipse.emf.cdo.session.remote.CDORemoteSessionMessage-">sendMessage</a></span>(<a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionMessage.html" title="class in org.eclipse.emf.cdo.session.remote">CDORemoteSessionMessage</a> message)</code> <div class="block">Sends a unicast message to this remote session if it is subscribed.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Comparable"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Comparable"> <!-- --> </a> <h3>Methods inherited from interface java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a></h3> -<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</a></code></li> +<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang">compareTo</a></code></li> </ul> </li> </ul> @@ -179,11 +194,11 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getManager()"> +<a name="getManager--"> <!-- --> </a> <ul class="blockList"> @@ -193,7 +208,7 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp <div class="block">Returns the remote session manager that manages this remote session.</div> </li> </ul> -<a name="getSessionID()"> +<a name="getSessionID--"> <!-- --> </a> <ul class="blockList"> @@ -203,7 +218,7 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp <div class="block">Returns the session ID of this remote session.</div> </li> </ul> -<a name="getUserID()"> +<a name="getUserID--"> <!-- --> </a> <ul class="blockList"> @@ -213,7 +228,7 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp <div class="block">Returns the user ID of this remote session.</div> </li> </ul> -<a name="isSubscribed()"> +<a name="isSubscribed--"> <!-- --> </a> <ul class="blockList"> @@ -224,7 +239,7 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp delivers <a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionEvent.MessageReceived.html" title="interface in org.eclipse.emf.cdo.session.remote"><code>custom data events</code></a>, <code>false</code> otherwise.</div> </li> </ul> -<a name="sendMessage(org.eclipse.emf.cdo.session.remote.CDORemoteSessionMessage)"> +<a name="sendMessage-org.eclipse.emf.cdo.session.remote.CDORemoteSessionMessage-"> <!-- --> </a> <ul class="blockListLast"> @@ -232,13 +247,18 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp <h4>sendMessage</h4> <pre>boolean sendMessage(<a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionMessage.html" title="class in org.eclipse.emf.cdo.session.remote">CDORemoteSessionMessage</a> message)</pre> <div class="block">Sends a unicast message to this remote session if it is subscribed.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the server received the custom data message, <code>false</code> otherwise. +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if the server received the custom data message, <code>false</code> otherwise. <b>Note:</b> No assumption must be made on whether the recipient session received the message and was able to handle it adequately!</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="../../../../../../org/eclipse/emf/cdo/common/util/CDOException.html" title="class in org.eclipse.emf.cdo.common.util">CDOException</a></code> - if this remote session is not subscribed.</dd><dt><span class="strong">Since:</span></dt> - <dd>3.0</dd> -<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#isSubscribed()"><code>isSubscribed()</code></a></dd></dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/eclipse/emf/cdo/common/util/CDOException.html" title="class in org.eclipse.emf.cdo.common.util">CDOException</a></code> - if this remote session is not subscribed.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSession.html#isSubscribed--"><code>isSubscribed()</code></a></dd> +</dl> </li> </ul> </li> @@ -249,9 +269,11 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -266,15 +288,15 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionEvent.html" title="interface in org.eclipse.emf.cdo.session.remote"><span class="strong">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../../../../org/eclipse/emf/cdo/session/remote/CDORemoteSessionEvent.html" title="interface in org.eclipse.emf.cdo.session.remote"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/eclipse/emf/cdo/session/remote/CDORemoteSession.html" target="_top">Frames</a></li> -<li><a href="CDORemoteSession.html" target="_top">No Frames</a></li> +<li><a href="CDORemoteSession.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -294,19 +316,19 @@ extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comp <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small><i>Copyright (c) 2011, 2012 Eike Stepper (Berlin, Germany) and others.</i></small></p> +<p class="legalCopy"><small><i>Copyright (c) 2011-2014 Eike Stepper (Berlin, Germany) and others.</i></small></p> </body> </html> |