blob: 82b027164f115e3a4e7a82f04c7614dc936836de [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_21) on Wed Jun 12 19:57:03 BST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1">
<title>IRemoteConnectionChangeEvent (PTP API Specification)</title>
<meta name="date" content="2013-06-12">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IRemoteConnectionChangeEvent (PTP API Specification)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IRemoteConnectionChangeEvent.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeListener.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html" target="_top">Frames</a></li>
<li><a href="IRemoteConnectionChangeEvent.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>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.ptp.remote.core</div>
<h2 title="Interface IRemoteConnectionChangeEvent" class="title">Interface IRemoteConnectionChangeEvent</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">IRemoteConnectionChangeEvent</span></pre>
<div class="block">Event representing a change in connection status. The <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#getType()"><code>getType()</code></a> method can be used to obtain information about the type
of event that occurred.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_ABORTED">CONNECTION_ABORTED</a></strong></code>
<div class="block">Event indicating that the connection was closed abnormally.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_CLOSED">CONNECTION_CLOSED</a></strong></code>
<div class="block">Event indicating that the connection was closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_OPENED">CONNECTION_OPENED</a></strong></code>
<div class="block">Event indicating that the connection was opened.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_RENAMED">CONNECTION_RENAMED</a></strong></code>
<div class="block">Event indicating that the connection name was changed.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<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">&nbsp;</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">
<td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#getConnection()">getConnection</a></strong>()</code>
<div class="block">Get the connection that has changed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#getType()">getType</a></strong>()</code>
<div class="block">Returns the type of event being reported.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CONNECTION_CLOSED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONNECTION_CLOSED</h4>
<pre>static final&nbsp;int CONNECTION_CLOSED</pre>
<div class="block">Event indicating that the connection was closed.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.core.IRemoteConnectionChangeEvent.CONNECTION_CLOSED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CONNECTION_OPENED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONNECTION_OPENED</h4>
<pre>static final&nbsp;int CONNECTION_OPENED</pre>
<div class="block">Event indicating that the connection was opened.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.core.IRemoteConnectionChangeEvent.CONNECTION_OPENED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CONNECTION_ABORTED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONNECTION_ABORTED</h4>
<pre>static final&nbsp;int CONNECTION_ABORTED</pre>
<div class="block">Event indicating that the connection was closed abnormally.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.core.IRemoteConnectionChangeEvent.CONNECTION_ABORTED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CONNECTION_RENAMED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CONNECTION_RENAMED</h4>
<pre>static final&nbsp;int CONNECTION_RENAMED</pre>
<div class="block">Event indicating that the connection name was changed.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.core.IRemoteConnectionChangeEvent.CONNECTION_RENAMED">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConnection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a>&nbsp;getConnection()</pre>
<div class="block">Get the connection that has changed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>IRemoteConnection</dd></dl>
</li>
</ul>
<a name="getType()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getType</h4>
<pre>int&nbsp;getType()</pre>
<div class="block">Returns the type of event being reported. This type
is obtained by bitwise OR'ing the event types together.
<a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_CLOSED"><code>CONNECTION_CLOSED</code></a> <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_OPENED"><code>CONNECTION_OPENED</code></a> <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_ABORTED"><code>CONNECTION_ABORTED</code></a> <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html#CONNECTION_RENAMED"><code>CONNECTION_RENAMED</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a bitwise OR of event type constants</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IRemoteConnectionChangeEvent.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnectionChangeListener.html" title="interface in org.eclipse.ptp.remote.core"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/ptp/remote/core/IRemoteConnectionChangeEvent.html" target="_top">Frames</a></li>
<li><a href="IRemoteConnectionChangeEvent.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>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p>
</body>
</html>