<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0) on Thu Dec 06 18:47:27 CET 2012 -->
<TITLE>
OtpNode (Java-Erlang Interface Library)
</TITLE>
<META NAME="keywords" CONTENT="com.ericsson.otp.erlang.OtpNode class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="OtpNode (Java-Erlang Interface Library)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/ericsson/otp/erlang/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang"><B>PREV CLASS</B></A>
<A HREF="../../../../com/ericsson/otp/erlang/OtpNode.Acceptor.html" title="class in com.ericsson.otp.erlang"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/ericsson/otp/erlang/OtpNode.html" target="_top"><B>FRAMES</B></A>
<A HREF="OtpNode.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_com.ericsson.otp.erlang.OtpLocalNode">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<A NAME="main"></A>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.ericsson.otp.erlang</FONT>
<BR>
Class OtpNode</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html" title="class in com.ericsson.otp.erlang">com.ericsson.otp.erlang.AbstractNode</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">com.ericsson.otp.erlang.OtpLocalNode</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.ericsson.otp.erlang.OtpNode</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>OtpNode</B><DT>extends <A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">OtpLocalNode</A></DL>
</PRE>
<P>
<p>
Represents a local OTP node. This class is used when you do not wish to
manage connections yourself - outgoing connections are established as needed,
and incoming connections accepted automatically. This class supports the use
of a mailbox API for communication, while management of the underlying
communication mechanism is automatic and hidden from the application
programmer.
</p>
<p>
Once an instance of this class has been created, obtain one or more mailboxes
in order to send or receive messages. The first message sent to a given node
will cause a connection to be set up to that node. Any messages received will
be delivered to the appropriate mailboxes.
</p>
<p>
To shut down the node, call <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#close()"><CODE>close()</CODE></A>. This will prevent the
node from accepting additional connections and it will cause all existing
connections to be closed. Any unread messages in existing mailboxes can still
be read, however no new messages will be delivered to the mailboxes.
</p>
<p>
Note that the use of this class requires that Epmd (Erlang Port Mapper
Daemon) is running on each cooperating host. This class does not start Epmd
automatically as Erlang does, you must start it manually or through some
other means. See the Erlang documentation for more information about this.
</p>
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.Acceptor.html" title="class in com.ericsson.otp.erlang">OtpNode.Acceptor</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.Mailboxes.html" title="class in com.ericsson.otp.erlang">OtpNode.Mailboxes</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_com.ericsson.otp.erlang.OtpLocalNode"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class com.ericsson.otp.erlang.<A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">OtpLocalNode</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#epmd">epmd</A>, <A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#port">port</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#OtpNode(java.lang.String)">OtpNode</A></B>(java.lang.String node)</CODE>
<BR>
Create a node using the default cookie.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#OtpNode(java.lang.String, java.lang.String)">OtpNode</A></B>(java.lang.String node,
java.lang.String cookie)</CODE>
<BR>
Create a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#OtpNode(java.lang.String, java.lang.String, int)">OtpNode</A></B>(java.lang.String node,
java.lang.String cookie,
int port)</CODE>
<BR>
Create a node.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#close()">close</A></B>()</CODE>
<BR>
Close the node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#closeMbox(com.ericsson.otp.erlang.OtpMbox)">closeMbox</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> mbox)</CODE>
<BR>
Close the specified mailbox with reason 'normal'.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#closeMbox(com.ericsson.otp.erlang.OtpMbox, com.ericsson.otp.erlang.OtpErlangObject)">closeMbox</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> mbox,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> reason)</CODE>
<BR>
Close the specified mailbox with the given reason.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#createMbox()">createMbox</A></B>()</CODE>
<BR>
Create an unnamed <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang"><CODE>mailbox</CODE></A> that can be used to send and
receive messages with other, similar mailboxes and with Erlang processes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#createMbox(java.lang.String)">createMbox</A></B>(java.lang.String name)</CODE>
<BR>
Create an named mailbox that can be used to send and receive messages
with other, similar mailboxes and with Erlang processes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#finalize()">finalize</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#getNames()">getNames</A></B>()</CODE>
<BR>
Get a list of all known registered names on this node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#ping(java.lang.String, long)">ping</A></B>(java.lang.String node,
long timeout)</CODE>
<BR>
Determine if another node is alive.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#registerName(java.lang.String, com.ericsson.otp.erlang.OtpMbox)">registerName</A></B>(java.lang.String name,
<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> mbox)</CODE>
<BR>
Register or remove a name for the given mailbox.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#registerStatusHandler(com.ericsson.otp.erlang.OtpNodeStatus)">registerStatusHandler</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpNodeStatus.html" title="class in com.ericsson.otp.erlang">OtpNodeStatus</A> handler)</CODE>
<BR>
Register interest in certain system events.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#setFlags(int)">setFlags</A></B>(int flags)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#whereis(java.lang.String)">whereis</A></B>(java.lang.String name)</CODE>
<BR>
Determine the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> corresponding to a registered name
on this node.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_com.ericsson.otp.erlang.OtpLocalNode"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.ericsson.otp.erlang.<A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html" title="class in com.ericsson.otp.erlang">OtpLocalNode</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#createPid()">createPid</A>, <A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#createPort()">createPort</A>, <A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#createRef()">createRef</A>, <A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#getEpmd()">getEpmd</A>, <A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#port()">port</A>, <A HREF="../../../../com/ericsson/otp/erlang/OtpLocalNode.html#setEpmd(java.net.Socket)">setEpmd</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_com.ericsson.otp.erlang.AbstractNode"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.ericsson.otp.erlang.<A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html" title="class in com.ericsson.otp.erlang">AbstractNode</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html#alive()">alive</A>, <A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html#cookie()">cookie</A>, <A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html#host()">host</A>, <A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html#node()">node</A>, <A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html#setCookie(java.lang.String)">setCookie</A>, <A HREF="../../../../com/ericsson/otp/erlang/AbstractNode.html#toString()">toString</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="OtpNode(java.lang.String)"><!-- --></A><H3>
OtpNode</H3>
<PRE>
public <B>OtpNode</B>(java.lang.String node)
throws java.io.IOException</PRE>
<DL>
<DD><p>
Create a node using the default cookie. The default cookie is found by
reading the first line of the .erlang.cookie file in the user's home
directory. The home directory is obtained from the System property
"user.home".
</p>
<p>
If the file does not exist, an empty string is used. This method makes no
attempt to create the file.
</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the name of this node.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if communication could not be initialized.</DL>
</DL>
<HR>
<A NAME="OtpNode(java.lang.String, java.lang.String)"><!-- --></A><H3>
OtpNode</H3>
<PRE>
public <B>OtpNode</B>(java.lang.String node,
java.lang.String cookie)
throws java.io.IOException</PRE>
<DL>
<DD>Create a node.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the name of this node.<DD><CODE>cookie</CODE> - the authorization cookie that will be used by this node when
it communicates with other nodes.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if communication could not be initialized.</DL>
</DL>
<HR>
<A NAME="OtpNode(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
OtpNode</H3>
<PRE>
public <B>OtpNode</B>(java.lang.String node,
java.lang.String cookie,
int port)
throws java.io.IOException</PRE>
<DL>
<DD>Create a node.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the name of this node.<DD><CODE>cookie</CODE> - the authorization cookie that will be used by this node when
it communicates with other nodes.<DD><CODE>port</CODE> - the port number you wish to use for incoming connections.
Specifying 0 lets the system choose an available port.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if communication could not be initialized.</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>Close the node. Unpublish the node from Epmd (preventing new connections)
and close all existing connections.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="finalize()"><!-- --></A><H3>
finalize</H3>
<PRE>
protected void <B>finalize</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>finalize</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createMbox()"><!-- --></A><H3>
createMbox</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> <B>createMbox</B>()</PRE>
<DL>
<DD>Create an unnamed <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang"><CODE>mailbox</CODE></A> that can be used to send and
receive messages with other, similar mailboxes and with Erlang processes.
Messages can be sent to this mailbox by using its associated
<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#self()"><CODE>pid</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a mailbox.</DL>
</DD>
</DL>
<HR>
<A NAME="closeMbox(com.ericsson.otp.erlang.OtpMbox)"><!-- --></A><H3>
closeMbox</H3>
<PRE>
public void <B>closeMbox</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> mbox)</PRE>
<DL>
<DD>Close the specified mailbox with reason 'normal'.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mbox</CODE> - the mailbox to close.
<p>
After this operation, the mailbox will no longer be able to
receive messages. Any delivered but as yet unretrieved
messages can still be retrieved however.
</p>
<p>
If there are links from the mailbox to other
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pids</CODE></A>, they will be broken when this
method is called and exit signals with reason 'normal' will be
sent.
</p></DL>
</DD>
</DL>
<HR>
<A NAME="closeMbox(com.ericsson.otp.erlang.OtpMbox, com.ericsson.otp.erlang.OtpErlangObject)"><!-- --></A><H3>
closeMbox</H3>
<PRE>
public void <B>closeMbox</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> mbox,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> reason)</PRE>
<DL>
<DD>Close the specified mailbox with the given reason.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mbox</CODE> - the mailbox to close.<DD><CODE>reason</CODE> - an Erlang term describing the reason for the termination.
<p>
After this operation, the mailbox will no longer be able to
receive messages. Any delivered but as yet unretrieved
messages can still be retrieved however.
</p>
<p>
If there are links from the mailbox to other
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pids</CODE></A>, they will be broken when this
method is called and exit signals with the given reason will
be sent.
</p></DL>
</DD>
</DL>
<HR>
<A NAME="createMbox(java.lang.String)"><!-- --></A><H3>
createMbox</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> <B>createMbox</B>(java.lang.String name)</PRE>
<DL>
<DD>Create an named mailbox that can be used to send and receive messages
with other, similar mailboxes and with Erlang processes. Messages can be
sent to this mailbox by using its registered name or the associated
<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#self()"><CODE>pid</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a name to register for this mailbox. The name must be unique
within this OtpNode.
<DT><B>Returns:</B><DD>a mailbox, or null if the name was already in use.</DL>
</DD>
</DL>
<HR>
<A NAME="registerName(java.lang.String, com.ericsson.otp.erlang.OtpMbox)"><!-- --></A><H3>
registerName</H3>
<PRE>
public boolean <B>registerName</B>(java.lang.String name,
<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang">OtpMbox</A> mbox)</PRE>
<DL>
<DD><p>
Register or remove a name for the given mailbox. Registering a name for a
mailbox enables others to send messages without knowing the
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> of the mailbox. A mailbox can have at most one
name; if the mailbox already had a name, calling this method will
supercede that name.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to register for the mailbox. Specify null to
unregister the existing name from this mailbox.<DD><CODE>mbox</CODE> - the mailbox to associate with the name.
<DT><B>Returns:</B><DD>true if the name was available, or false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="getNames()"><!-- --></A><H3>
getNames</H3>
<PRE>
public java.lang.String[] <B>getNames</B>()</PRE>
<DL>
<DD>Get a list of all known registered names on this node.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an array of Strings, containins all known registered names on
this node.</DL>
</DD>
</DL>
<HR>
<A NAME="whereis(java.lang.String)"><!-- --></A><H3>
whereis</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> <B>whereis</B>(java.lang.String name)</PRE>
<DL>
<DD>Determine the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> corresponding to a registered name
on this node.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> corresponding to the registered
name, or null if the name is not known on this node.</DL>
</DD>
</DL>
<HR>
<A NAME="registerStatusHandler(com.ericsson.otp.erlang.OtpNodeStatus)"><!-- --></A><H3>
registerStatusHandler</H3>
<PRE>
public void <B>registerStatusHandler</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpNodeStatus.html" title="class in com.ericsson.otp.erlang">OtpNodeStatus</A> handler)</PRE>
<DL>
<DD>Register interest in certain system events. The <A HREF="../../../../com/ericsson/otp/erlang/OtpNodeStatus.html" title="class in com.ericsson.otp.erlang"><CODE>OtpNodeStatus</CODE></A> handler object contains callback methods, that will be
called when certain events occur.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>handler</CODE> - the callback object to register. To clear the handler, specify
null as the handler to use.</DL>
</DD>
</DL>
<HR>
<A NAME="ping(java.lang.String, long)"><!-- --></A><H3>
ping</H3>
<PRE>
public boolean <B>ping</B>(java.lang.String node,
long timeout)</PRE>
<DL>
<DD><p>
Determine if another node is alive. This method has the side effect of
setting up a connection to the remote node (if possible). Only a single
outgoing message is sent; the timeout is how long to wait for a response.
</p>
<p>
Only a single attempt is made to connect to the remote node, so for
example it is not possible to specify an extremely long timeout and
expect to be notified when the node eventually comes up. If you wish to
wait for a remote node to be started, the following construction may be
useful:
</p>
<pre>
// ping every 2 seconds until positive response
while (!me.ping(him, 2000))
;
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the name of the node to ping.<DD><CODE>timeout</CODE> - the time, in milliseconds, to wait for response before
returning false.
<DT><B>Returns:</B><DD>true if the node was alive and the correct ping response was
returned. false if the correct response was not returned on time.</DL>
</DD>
</DL>
<HR>
<A NAME="setFlags(int)"><!-- --></A><H3>
setFlags</H3>
<PRE>
public void <B>setFlags</B>(int flags)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/ericsson/otp/erlang/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang"><B>PREV CLASS</B></A>
<A HREF="../../../../com/ericsson/otp/erlang/OtpNode.Acceptor.html" title="class in com.ericsson.otp.erlang"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/ericsson/otp/erlang/OtpNode.html" target="_top"><B>FRAMES</B></A>
<A HREF="OtpNode.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_com.ericsson.otp.erlang.OtpLocalNode">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
870
