blob: 2e1196fdee94413556ef4b02ab034f48a1a70018 [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>
<title>MulticastPulseClient</title>
<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"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MulticastPulseClient";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":9,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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">
<!-- -->
</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">
<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="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.URIs.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openejb/client/MulticastSearch.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openejb/client/MulticastPulseClient.html" target="_top">Frames</a></li>
<li><a href="MulticastPulseClient.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.classes.inherited.from.class.org.apache.openejb.client.MulticastConnectionFactory">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.apache.openejb.client</div>
<h2 title="Class MulticastPulseClient" class="title">Class MulticastPulseClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html" title="class in org.apache.openejb.client">org.apache.openejb.client.MulticastConnectionFactory</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openejb.client.MulticastPulseClient</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/openejb/client/ConnectionFactory.html" title="interface in org.apache.openejb.client">ConnectionFactory</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MulticastPulseClient</span>
extends <a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html" title="class in org.apache.openejb.client">MulticastConnectionFactory</a></pre>
<div class="block">Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.openejb.client.MulticastConnectionFactory">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.openejb.client.<a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html" title="class in org.apache.openejb.client">MulticastConnectionFactory</a></h3>
<code><a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.Filter.html" title="class in org.apache.openejb.client">MulticastConnectionFactory.Filter</a>, <a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.URIs.html" title="class in org.apache.openejb.client">MulticastConnectionFactory.URIs</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" 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 java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#ORG_APACHE_OPENEJB_MULTIPULSE_TTL">ORG_APACHE_OPENEJB_MULTIPULSE_TTL</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#ORG_APACHE_OPENEJB_MULTIPULSE_URI_LIMIT">ORG_APACHE_OPENEJB_MULTIPULSE_URI_LIMIT</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#MulticastPulseClient--">MulticastPulseClient</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static java.util.Set&lt;java.net.URI&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#discoverURIs-java.lang.String-java.util.Set-java.lang.String-int-long-">discoverURIs</a></span>(java.lang.String&nbsp;forGroup,
java.util.Set&lt;java.lang.String&gt;&nbsp;schemes,
java.lang.String&nbsp;host,
int&nbsp;port,
long&nbsp;timeout)</code>
<div class="block">Get a list of URIs discovered for the provided request.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openejb/client/Connection.html" title="interface in org.apache.openejb.client">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#getConnection-java.net.URI-">getConnection</a></span>(java.net.URI&nbsp;uri)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.net.MulticastSocket[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#getSockets-java.net.InetAddress-int-">getSockets</a></span>(java.net.InetAddress&nbsp;ia,
int&nbsp;port)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#isLocalAddress-java.lang.String-boolean-">isLocalAddress</a></span>(java.lang.String&nbsp;host,
boolean&nbsp;wildcardIsLocal)</code>
<div class="block">Is the provided host a local host</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/client/MulticastPulseClient.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;args)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.client.MulticastConnectionFactory">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openejb.client.<a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html" title="class in org.apache.openejb.client">MulticastConnectionFactory</a></h3>
<code><a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html#getDefaultSchemes--">getDefaultSchemes</a>, <a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html#getLong-java.util.Map-java.lang.String-long-">getLong</a>, <a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html#getSet-java.util.Map-java.lang.String-java.util.Set-">getSet</a>, <a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html#getString-java.util.Map-java.lang.String-java.lang.String-">getString</a>, <a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html#unwrap-java.net.URI-">unwrap</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="ORG_APACHE_OPENEJB_MULTIPULSE_TTL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ORG_APACHE_OPENEJB_MULTIPULSE_TTL</h4>
<pre>public static final&nbsp;java.lang.String ORG_APACHE_OPENEJB_MULTIPULSE_TTL</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openejb.client.MulticastPulseClient.ORG_APACHE_OPENEJB_MULTIPULSE_TTL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ORG_APACHE_OPENEJB_MULTIPULSE_URI_LIMIT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ORG_APACHE_OPENEJB_MULTIPULSE_URI_LIMIT</h4>
<pre>public static final&nbsp;java.lang.String ORG_APACHE_OPENEJB_MULTIPULSE_URI_LIMIT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openejb.client.MulticastPulseClient.ORG_APACHE_OPENEJB_MULTIPULSE_URI_LIMIT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MulticastPulseClient--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MulticastPulseClient</h4>
<pre>public&nbsp;MulticastPulseClient()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConnection-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openejb/client/Connection.html" title="interface in org.apache.openejb.client">Connection</a>&nbsp;getConnection(java.net.URI&nbsp;uri)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openejb/client/ConnectionFactory.html#getConnection-java.net.URI-">getConnection</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openejb/client/ConnectionFactory.html" title="interface in org.apache.openejb.client">ConnectionFactory</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html#getConnection-java.net.URI-">getConnection</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.html" title="class in org.apache.openejb.client">MulticastConnectionFactory</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - Connection URI</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Connection</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - or error</dd>
<dd><code>java.lang.IllegalArgumentException</code> - On undefined error</dd>
</dl>
</li>
</ul>
<a name="discoverURIs-java.lang.String-java.util.Set-java.lang.String-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>discoverURIs</h4>
<pre>public static&nbsp;java.util.Set&lt;java.net.URI&gt;&nbsp;discoverURIs(java.lang.String&nbsp;forGroup,
java.util.Set&lt;java.lang.String&gt;&nbsp;schemes,
java.lang.String&nbsp;host,
int&nbsp;port,
long&nbsp;timeout)
throws java.lang.Exception</pre>
<div class="block">Get a list of URIs discovered for the provided request.
Returned URIs are of the format 'mp-{serverhost}:group:scheme://servicehost:port'.
The serverhost is prefixed with 'mp-' in case the serverhost is an IP-Address, as RFC 2396 defines scheme must begin with a 'letter'</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>forGroup</code> - Specific case sensitive group name or * for all</dd>
<dd><code>schemes</code> - Acceptable scheme list</dd>
<dd><code>host</code> - Multicast host address</dd>
<dd><code>port</code> - Multicast port</dd>
<dd><code>timeout</code> - Time to wait for a server response, at least 50ms</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A URI set, possibly empty</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - On error</dd>
</dl>
</li>
</ul>
<a name="isLocalAddress-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLocalAddress</h4>
<pre>public static&nbsp;boolean&nbsp;isLocalAddress(java.lang.String&nbsp;host,
boolean&nbsp;wildcardIsLocal)</pre>
<div class="block">Is the provided host a local host</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - The host to test</dd>
<dd><code>wildcardIsLocal</code> - Should 0.0.0.0 or [::] be deemed as local</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True is the host is a local host else false</dd>
</dl>
</li>
</ul>
<a name="getSockets-java.net.InetAddress-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSockets</h4>
<pre>public static&nbsp;java.net.MulticastSocket[]&nbsp;getSockets(java.net.InetAddress&nbsp;ia,
int&nbsp;port)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></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>
<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">
<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="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openejb/client/MulticastConnectionFactory.URIs.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openejb/client/MulticastSearch.html" title="class in org.apache.openejb.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openejb/client/MulticastPulseClient.html" target="_top">Frames</a></li>
<li><a href="MulticastPulseClient.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.classes.inherited.from.class.org.apache.openejb.client.MulticastConnectionFactory">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>