<!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>
OtpMbox (Java-Erlang Interface Library)
</TITLE>
<META NAME="keywords" CONTENT="com.ericsson.otp.erlang.OtpMbox class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="OtpMbox (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/OtpLocalNode.html" title="class in com.ericsson.otp.erlang"><B>PREV CLASS</B></A>
<A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.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/OtpMbox.html" target="_top"><B>FRAMES</B></A>
<A HREF="OtpMbox.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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 OtpMbox</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.ericsson.otp.erlang.OtpMbox</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>OtpMbox</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
<p>
Provides a simple mechanism for exchanging messages with Erlang processes or
other instances of this class.
</p>
<p>
Each mailbox is associated with a unique <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> that
contains information necessary for delivery of messages. When sending
messages to named processes or mailboxes, the sender pid is made available to
the recipient of the message. When sending messages to other mailboxes, the
recipient can only respond if the sender includes the pid as part of the
message contents. The sender can determine his own pid by calling
<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#self()"><CODE>self()</CODE></A>.
</p>
<p>
Mailboxes can be named, either at creation or later. Messages can be sent to
named mailboxes and named Erlang processes without knowing the
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> that identifies the mailbox. This is neccessary in
order to set up initial communication between parts of an application. Each
mailbox can have at most one name.
</p>
<p>
Since this class was intended for communication with Erlang, all of the send
methods take <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang"><CODE>OtpErlangObject</CODE></A> arguments. However this
class can also be used to transmit arbitrary Java objects (as long as they
implement one of java.io.Serializable or java.io.Externalizable) by
encapsulating the object in a <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangBinary.html" title="class in com.ericsson.otp.erlang"><CODE>OtpErlangBinary</CODE></A>.
</p>
<p>
Messages to remote nodes are externalized for transmission, and as a result
the recipient receives a <b>copy</b> of the original Java object. To ensure
consistent behaviour when messages are sent between local mailboxes, such
messages are cloned before delivery.
</p>
<p>
Additionally, mailboxes can be linked in much the same way as Erlang
processes. If a link is active when a mailbox is <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#close()"><CODE>closed</CODE></A>, any
linked Erlang processes or OtpMboxes will be sent an exit signal. As well,
exit signals will be (eventually) sent if a mailbox goes out of scope and its
<A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#finalize()"><CODE>finalize()</CODE></A> method called. However due to the nature of
finalization (i.e. Java makes no guarantees about when <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#finalize()"><CODE>finalize()</CODE></A> will be called) it is recommended that you always explicitly
close mailboxes if you are using links instead of relying on finalization to
notify other parties in a timely manner.
</p>
When retrieving messages from a mailbox that has received an exit signal, an
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang"><CODE>OtpErlangExit</CODE></A> exception will be raised. Note that the
exception is queued in the mailbox along with other messages, and will not be
raised until it reaches the head of the queue and is about to be retrieved.
</p>
<P>
<P>
<HR>
<P>
<!-- ========== 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/OtpMbox.html#close()">close</A></B>()</CODE>
<BR>
Close this mailbox.</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/OtpMbox.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object o)</CODE>
<BR>
Determine if two mailboxes are equal.</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/OtpMbox.html#exit(com.ericsson.otp.erlang.OtpErlangObject)">exit</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> reason)</CODE>
<BR>
Close this mailbox with the given reason.</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/OtpMbox.html#exit(com.ericsson.otp.erlang.OtpErlangPid, com.ericsson.otp.erlang.OtpErlangObject)">exit</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> reason)</CODE>
<BR>
Send an exit signal to a remote <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A>.</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/OtpMbox.html#exit(com.ericsson.otp.erlang.OtpErlangPid, java.lang.String)">exit</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to,
java.lang.String reason)</CODE>
<BR>
Equivalent to <code>exit(to, new
OtpErlangAtom(reason))</code>.</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/OtpMbox.html#exit(java.lang.String)">exit</A></B>(java.lang.String reason)</CODE>
<BR>
Equivalent to <code>exit(new OtpErlangAtom(reason))</code>.</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/OtpMbox.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/OtpMbox.html#getName()">getName</A></B>()</CODE>
<BR>
Get the registered name of this mailbox.</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/OtpMbox.html#getNames()">getNames</A></B>()</CODE>
<BR>
Get a list of all known registered names on the same <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html" title="class in com.ericsson.otp.erlang"><CODE>node</CODE></A>
as this mailbox.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
</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/OtpMbox.html#link(com.ericsson.otp.erlang.OtpErlangPid)">link</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to)</CODE>
<BR>
Link to a remote mailbox or Erlang process.</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/OtpMbox.html#ping(java.lang.String, long)">ping</A></B>(java.lang.String node,
long timeout)</CODE>
<BR>
Create a connection to a remote node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#receive()">receive</A></B>()</CODE>
<BR>
Block until a message arrives for this mailbox.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#receive(long)">receive</A></B>(long timeout)</CODE>
<BR>
Wait for a message to arrive for this mailbox.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#receiveBuf()">receiveBuf</A></B>()</CODE>
<BR>
Block until a message arrives for this mailbox.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#receiveBuf(long)">receiveBuf</A></B>(long timeout)</CODE>
<BR>
Wait for a message to arrive for this mailbox.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang">OtpMsg</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#receiveMsg()">receiveMsg</A></B>()</CODE>
<BR>
Block until a message arrives for this mailbox.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang">OtpMsg</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#receiveMsg(long)">receiveMsg</A></B>(long timeout)</CODE>
<BR>
Wait for a message to arrive for this mailbox.</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/OtpMbox.html#registerName(java.lang.String)">registerName</A></B>(java.lang.String name)</CODE>
<BR>
Register or remove a name for this mailbox.</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/OtpMbox.html#self()">self</A></B>()</CODE>
<BR>
Get the identifying <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> associated with this
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/OtpMbox.html#send(com.ericsson.otp.erlang.OtpErlangPid, com.ericsson.otp.erlang.OtpErlangObject)">send</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> msg)</CODE>
<BR>
Send a message to a remote <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A>, representing either
another <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang"><CODE>mailbox</CODE></A> or an Erlang process.</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/OtpMbox.html#send(java.lang.String, com.ericsson.otp.erlang.OtpErlangObject)">send</A></B>(java.lang.String name,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> msg)</CODE>
<BR>
Send a message to a named mailbox created from the same node as this
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/OtpMbox.html#send(java.lang.String, java.lang.String, com.ericsson.otp.erlang.OtpErlangObject)">send</A></B>(java.lang.String name,
java.lang.String node,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> msg)</CODE>
<BR>
Send a message to a named mailbox created from another 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/OtpMbox.html#unlink(com.ericsson.otp.erlang.OtpErlangPid)">unlink</A></B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to)</CODE>
<BR>
Remove a link to a remote mailbox or Erlang process.</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/OtpMbox.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 <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html" title="class in com.ericsson.otp.erlang"><CODE>node</CODE></A>.</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, getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="self()"><!-- --></A><H3>
self</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> <B>self</B>()</PRE>
<DL>
<DD><p>
Get the identifying <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> associated with this
mailbox.
</p>
<p>
The <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> associated with this mailbox uniquely
identifies the mailbox and can be used to address the mailbox. You can
send the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> to a remote communicating part so that
he can know where to send his response.
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the self pid for this mailbox.</DL>
</DD>
</DL>
<HR>
<A NAME="registerName(java.lang.String)"><!-- --></A><H3>
registerName</H3>
<PRE>
public boolean <B>registerName</B>(java.lang.String name)</PRE>
<DL>
<DD><p>
Register or remove a name for this 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.
<DT><B>Returns:</B><DD>true if the name was available, or false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Get the registered name of this mailbox.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the registered name of this mailbox, or null if the mailbox had
no registered name.</DL>
</DD>
</DL>
<HR>
<A NAME="receive()"><!-- --></A><H3>
receive</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> <B>receive</B>()
throws <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A>,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</A></PRE>
<DL>
<DD>Block until a message arrives for this mailbox.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang"><CODE>OtpErlangObject</CODE></A> representing the body
of the next message waiting in this mailbox.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</A></CODE> - if the message can not be decoded.
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></CODE> - if a linked <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> has exited or has
sent an exit signal to this mailbox.</DL>
</DD>
</DL>
<HR>
<A NAME="receive(long)"><!-- --></A><H3>
receive</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> <B>receive</B>(long timeout)
throws <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A>,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</A></PRE>
<DL>
<DD>Wait for a message to arrive for this mailbox.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the time, in milliseconds, to wait for a message before
returning null.
<DT><B>Returns:</B><DD>an <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang"><CODE>OtpErlangObject</CODE></A> representing the body
of the next message waiting in this mailbox.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</A></CODE> - if the message can not be decoded.
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></CODE> - if a linked <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> has exited or has
sent an exit signal to this mailbox.</DL>
</DD>
</DL>
<HR>
<A NAME="receiveBuf()"><!-- --></A><H3>
receiveBuf</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</A> <B>receiveBuf</B>()
throws <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></PRE>
<DL>
<DD>Block until a message arrives for this mailbox.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a byte array representing the still-encoded body of the next
message waiting in this mailbox.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></CODE> - if a linked <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> has exited or has
sent an exit signal to this mailbox.</DL>
</DD>
</DL>
<HR>
<A NAME="receiveBuf(long)"><!-- --></A><H3>
receiveBuf</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</A> <B>receiveBuf</B>(long timeout)
throws java.lang.InterruptedException,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></PRE>
<DL>
<DD>Wait for a message to arrive for this mailbox.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the time, in milliseconds, to wait for a message before
returning null.
<DT><B>Returns:</B><DD>a byte array representing the still-encoded body of the next
message waiting in this mailbox.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></CODE> - if a linked <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> has exited or has
sent an exit signal to this mailbox.
<DD><CODE>java.lang.InterruptedException</CODE> - if no message if the method times out before a message
becomes available.</DL>
</DD>
</DL>
<HR>
<A NAME="receiveMsg()"><!-- --></A><H3>
receiveMsg</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang">OtpMsg</A> <B>receiveMsg</B>()
throws <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></PRE>
<DL>
<DD>Block until a message arrives for this mailbox.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an <A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang"><CODE>OtpMsg</CODE></A> containing the header information as
well as the body of the next message waiting in this mailbox.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></CODE> - if a linked <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> has exited or has
sent an exit signal to this mailbox.</DL>
</DD>
</DL>
<HR>
<A NAME="receiveMsg(long)"><!-- --></A><H3>
receiveMsg</H3>
<PRE>
public <A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang">OtpMsg</A> <B>receiveMsg</B>(long timeout)
throws java.lang.InterruptedException,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></PRE>
<DL>
<DD>Wait for a message to arrive for this mailbox.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the time, in milliseconds, to wait for a message.
<DT><B>Returns:</B><DD>an <A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.html" title="class in com.ericsson.otp.erlang"><CODE>OtpMsg</CODE></A> containing the header information as
well as the body of the next message waiting in this mailbox.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></CODE> - if a linked <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> has exited or has
sent an exit signal to this mailbox.
<DD><CODE>java.lang.InterruptedException</CODE> - if no message if the method times out before a message
becomes available.</DL>
</DD>
</DL>
<HR>
<A NAME="send(com.ericsson.otp.erlang.OtpErlangPid, com.ericsson.otp.erlang.OtpErlangObject)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> msg)</PRE>
<DL>
<DD>Send a message to a remote <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A>, representing either
another <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html" title="class in com.ericsson.otp.erlang"><CODE>mailbox</CODE></A> or an Erlang process.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>to</CODE> - the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> identifying the intended
recipient of the message.<DD><CODE>msg</CODE> - the body of the message to send.</DL>
</DD>
</DL>
<HR>
<A NAME="send(java.lang.String, com.ericsson.otp.erlang.OtpErlangObject)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(java.lang.String name,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> msg)</PRE>
<DL>
<DD>Send a message to a named mailbox created from the same node as this
mailbox.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the registered name of recipient mailbox.<DD><CODE>msg</CODE> - the body of the message to send.</DL>
</DD>
</DL>
<HR>
<A NAME="send(java.lang.String, java.lang.String, com.ericsson.otp.erlang.OtpErlangObject)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(java.lang.String name,
java.lang.String node,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> msg)</PRE>
<DL>
<DD>Send a message to a named mailbox created from another node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the registered name of recipient mailbox.<DD><CODE>node</CODE> - the name of the remote node where the recipient mailbox is
registered.<DD><CODE>msg</CODE> - the body of the message to send.</DL>
</DD>
</DL>
<HR>
<A NAME="exit(com.ericsson.otp.erlang.OtpErlangObject)"><!-- --></A><H3>
exit</H3>
<PRE>
public void <B>exit</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> reason)</PRE>
<DL>
<DD>Close this mailbox with the given reason.
<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 this 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 will be
sent.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reason</CODE> - an Erlang term describing the reason for the exit.</DL>
</DD>
</DL>
<HR>
<A NAME="exit(java.lang.String)"><!-- --></A><H3>
exit</H3>
<PRE>
public void <B>exit</B>(java.lang.String reason)</PRE>
<DL>
<DD>Equivalent to <code>exit(new OtpErlangAtom(reason))</code>.
</p>
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#exit(com.ericsson.otp.erlang.OtpErlangObject)"><CODE>exit(OtpErlangObject)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="exit(com.ericsson.otp.erlang.OtpErlangPid, com.ericsson.otp.erlang.OtpErlangObject)"><!-- --></A><H3>
exit</H3>
<PRE>
public void <B>exit</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to,
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</A> reason)</PRE>
<DL>
<DD><p>
Send an exit signal to a remote <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A>. This method
does not cause any links to be broken, except indirectly if the remote
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> exits as a result of this exit signal.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>to</CODE> - the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> to which the exit signal
should be sent.<DD><CODE>reason</CODE> - an Erlang term indicating the reason for the exit.</DL>
</DD>
</DL>
<HR>
<A NAME="exit(com.ericsson.otp.erlang.OtpErlangPid, java.lang.String)"><!-- --></A><H3>
exit</H3>
<PRE>
public void <B>exit</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to,
java.lang.String reason)</PRE>
<DL>
<DD><p>
Equivalent to <code>exit(to, new
OtpErlangAtom(reason))</code>.
</p>
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#exit(com.ericsson.otp.erlang.OtpErlangPid, com.ericsson.otp.erlang.OtpErlangObject)"><CODE>exit(OtpErlangPid, OtpErlangObject)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="link(com.ericsson.otp.erlang.OtpErlangPid)"><!-- --></A><H3>
link</H3>
<PRE>
public void <B>link</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to)
throws <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></PRE>
<DL>
<DD><p>
Link to a remote mailbox or Erlang process. Links are idempotent, calling
this method multiple times will not result in more than one link being
created.
</p>
<p>
If the remote process subsequently exits or the mailbox is closed, a
subsequent attempt to retrieve a message through this mailbox will cause
an <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang"><CODE>OtpErlangExit</CODE></A> exception to be raised. Similarly,
if the sending mailbox is closed, the linked mailbox or process will
receive an exit signal.
</p>
<p>
If the remote process cannot be reached in order to set the link, the
exception is raised immediately.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>to</CODE> - the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> representing the object to
link to.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/ericsson/otp/erlang/OtpErlangExit.html" title="class in com.ericsson.otp.erlang">OtpErlangExit</A></CODE> - if the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> referred to does not
exist or could not be reached.</DL>
</DD>
</DL>
<HR>
<A NAME="unlink(com.ericsson.otp.erlang.OtpErlangPid)"><!-- --></A><H3>
unlink</H3>
<PRE>
public void <B>unlink</B>(<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang">OtpErlangPid</A> to)</PRE>
<DL>
<DD><p>
Remove a link to a remote mailbox or Erlang process. This method removes
a link created with <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#link(com.ericsson.otp.erlang.OtpErlangPid)"><CODE>link()</CODE></A>. Links are idempotent; calling
this method once will remove all links between this mailbox and the
remote <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A>.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>to</CODE> - the <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> representing the object to
unlink from.</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>
Create a connection to a remote node.
</p>
<p>
Strictly speaking, this method is not necessary simply to set up a
connection, since connections are created automatically first time a
message is sent to a <A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pid</CODE></A> on the remote node.
</p>
<p>
This method makes it possible to wait for a node to come up, however, or
check that a node is still alive.
</p>
<p>
This method calls a method with the same name in <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#ping(java.lang.String, long)"><CODE>Otpnode</CODE></A> but is provided here for convenience.
</p>
<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, before reporting failure.</DL>
</DD>
</DL>
<HR>
<A NAME="getNames()"><!-- --></A><H3>
getNames</H3>
<PRE>
public java.lang.String[] <B>getNames</B>()</PRE>
<DL>
<DD><p>
Get a list of all known registered names on the same <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html" title="class in com.ericsson.otp.erlang"><CODE>node</CODE></A>
as this mailbox.
</p>
<p>
This method calls a method with the same name in <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#getNames()"><CODE>Otpnode</CODE></A> but is provided here for convenience.
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an array of Strings containing all registered names on this
<A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html" title="class in com.ericsson.otp.erlang"><CODE>node</CODE></A>.</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 <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html" title="class in com.ericsson.otp.erlang"><CODE>node</CODE></A>.
<p>
This method calls a method with the same name in <A HREF="../../../../com/ericsson/otp/erlang/OtpNode.html#whereis(java.lang.String)"><CODE>Otpnode</CODE></A> but is provided here for convenience.
</p>
<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="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>Close this mailbox.
<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 this 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>
<p>
This is equivalent to <A HREF="../../../../com/ericsson/otp/erlang/OtpMbox.html#exit(java.lang.String)"><CODE>exit("normal")</CODE></A>.
</p>
<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="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(java.lang.Object o)</PRE>
<DL>
<DD>Determine if two mailboxes are equal.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if both Objects are mailboxes with the same identifying
<A HREF="../../../../com/ericsson/otp/erlang/OtpErlangPid.html" title="class in com.ericsson.otp.erlang"><CODE>pids</CODE></A>.</DL>
</DD>
</DL>
<HR>
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<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/OtpLocalNode.html" title="class in com.ericsson.otp.erlang"><B>PREV CLASS</B></A>
<A HREF="../../../../com/ericsson/otp/erlang/OtpMsg.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/OtpMbox.html" target="_top"><B>FRAMES</B></A>
<A HREF="OtpMbox.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
