<!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_09-icedtea) on Sat Mar 02 06:46:25 UTC 2013 -->
<title>OtpEpmd (Java-Erlang Interface Library)</title>
<meta name="date" content="2013-03-02">
<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="OtpEpmd (Java-Erlang Interface Library)";
}
//-->
</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="../../../../com/ericsson/otp/erlang/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="../../../../com/ericsson/otp/erlang/OtpCookedConnection.html" title="class in com.ericsson.otp.erlang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangAtom.html" title="class in com.ericsson.otp.erlang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ericsson/otp/erlang/OtpEpmd.html" target="_top">Frames</a></li>
<li><a href="OtpEpmd.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </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>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.ericsson.otp.erlang</div>
<h2 title="Class OtpEpmd" class="title">Class OtpEpmd</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.ericsson.otp.erlang.OtpEpmd</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">OtpEpmd</span>
extends java.lang.Object</pre>
<div class="block">Provides methods for registering, unregistering and looking up nodes with the
Erlang portmapper daemon (Epmd). For each registered node, Epmd maintains
information about the port on which incoming connections are accepted, as
well as which versions of the Erlang communication protocolt the node
supports.
<p>
Nodes wishing to contact other nodes must first request information from Epmd
before a connection can be set up, however this is done automatically by
<a href="../../../../com/ericsson/otp/erlang/OtpSelf.html#connect(com.ericsson.otp.erlang.OtpPeer)"><code>OtpSelf.connect()</code></a> when necessary.
<p>
The methods <a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#publishPort(com.ericsson.otp.erlang.OtpLocalNode)"><code>publishPort()</code></a> and
<a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#unPublishPort(com.ericsson.otp.erlang.OtpLocalNode)"><code>unPublishPort()</code></a> will fail if an Epmd
process is not running on the localhost. Additionally
<a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#lookupPort(com.ericsson.otp.erlang.AbstractNode)"><code>lookupPort()</code></a> will fail if there is no Epmd
process running on the host where the specified node is running. See the
Erlang documentation for information about starting Epmd.
<p>
This class contains only static methods, there are no constructors.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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"> </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>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#lookupNames()">lookupNames</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#lookupNames(java.net.InetAddress)">lookupNames</a></strong>(java.net.InetAddress address)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#lookupPort(com.ericsson.otp.erlang.AbstractNode)">lookupPort</a></strong>(<a href="../../../../com/ericsson/otp/erlang/AbstractNode.html" title="class in com.ericsson.otp.erlang">AbstractNode</a> node)</code>
<div class="block">Determine what port a node listens for incoming connections on.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#publishPort(com.ericsson.otp.erlang.OtpLocalNode)">publishPort</a></strong>(<a href="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">OtpLocalNode</a> node)</code>
<div class="block">Register with Epmd, so that other nodes are able to find and connect to
it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#unPublishPort(com.ericsson.otp.erlang.OtpLocalNode)">unPublishPort</a></strong>(<a href="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">OtpLocalNode</a> node)</code>
<div class="block">Unregister from Epmd.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpEpmd.html#useEpmdPort(int)">useEpmdPort</a></strong>(int port)</code>
<div class="block">Set the port number to be used to contact the epmd process.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="useEpmdPort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useEpmdPort</h4>
<pre>public static void useEpmdPort(int port)</pre>
<div class="block">Set the port number to be used to contact the epmd process.
Only needed when the default port is not desired and system environment
variable ERL_EPMD_PORT can not be read (applet).</div>
</li>
</ul>
<a name="lookupPort(com.ericsson.otp.erlang.AbstractNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookupPort</h4>
<pre>public static int lookupPort(<a href="../../../../com/ericsson/otp/erlang/AbstractNode.html" title="class in com.ericsson.otp.erlang">AbstractNode</a> node)
throws java.io.IOException</pre>
<div class="block">Determine what port a node listens for incoming connections on.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the listen port for the specified node, or 0 if the node was not
registered with Epmd.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there was no response from the name server.</dd></dl>
</li>
</ul>
<a name="publishPort(com.ericsson.otp.erlang.OtpLocalNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>publishPort</h4>
<pre>public static boolean publishPort(<a href="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">OtpLocalNode</a> node)
throws java.io.IOException</pre>
<div class="block">Register with Epmd, so that other nodes are able to find and connect to
it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - the server node that should be registered with Epmd.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the operation was successful. False if the node was
already registered.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there was no response from the name server.</dd></dl>
</li>
</ul>
<a name="unPublishPort(com.ericsson.otp.erlang.OtpLocalNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unPublishPort</h4>
<pre>public static void unPublishPort(<a href="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">OtpLocalNode</a> node)</pre>
<div class="block">Unregister from Epmd. Other nodes wishing to connect will no longer be
able to.
<p>
This method does not report any failures.</div>
</li>
</ul>
<a name="lookupNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookupNames</h4>
<pre>public static java.lang.String[] lookupNames()
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="lookupNames(java.net.InetAddress)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lookupNames</h4>
<pre>public static java.lang.String[] lookupNames(java.net.InetAddress address)
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/ericsson/otp/erlang/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="../../../../com/ericsson/otp/erlang/OtpCookedConnection.html" title="class in com.ericsson.otp.erlang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangAtom.html" title="class in com.ericsson.otp.erlang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ericsson/otp/erlang/OtpEpmd.html" target="_top">Frames</a></li>
<li><a href="OtpEpmd.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </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>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
