basicmessenger.html

jxta的api库

</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/jxta/impl/endpoint/BasicMessenger.html#isIdle()">isIdle</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this messenger is not currently sending
 any messages and  the messenger has not been used for "a long time". Thus
 suggesting that closing it would be good.

 <p/>The definition of idleness is up to the implementing message
 transport, but is usually based upon the cost of re-opening a closed
 connection versus continued idleness.

 <p/>This is default implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/jxta/impl/endpoint/BasicMessenger.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">removePropertyChangeListener</A></B>(java.beans.PropertyChangeListener&nbsp;listener)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{@inheritDoc}</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/jxta/impl/endpoint/BasicMessenger.html#sendMessage(net.jxta.endpoint.Message)">sendMessage</A></B>(<A HREF="../../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;msg)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a message to the destination.

  <p/><b>WARNING:</b> The Message object should not be reused or modified
  until <code>sendMessage</code> has completed. Concurrent modification of
  a message while a messenger is sending the message will produce
  incorrect and unpredictable results. For asynchronous messengers this 
  method provides no notification of message send completion thus the
  message should <b>never</b> be reused. It is reccommended that a clone
  of the message be provided to send message:

  <p/><code><pre>
      messenger.sendMessage( (Message) myMessage.clone() );
  </pre></code>

  <p/>Error Handling:

  <ul>
  <li>Common Aspects:
      <ul>
          <li>An <CODE>IOException</CODE> means that the message
          was not sent and this message cannot be used to send subsequent
          messages. Instances of <CODE>RuntimeException</CODE> mean
          that the message was not sent, but retries may or may not be
          possible based upon the status returned by 
          <A HREF="../../../../net/jxta/endpoint/Messenger.html#isClosed()"><CODE>Messenger.isClosed()</CODE></A>.</li>

          <li>A return result of <code>false</code> indicates that the
          message was not accepted to be sent. Usually this is due to
          local resource limits being reached. Attempts may be made to
          later resend the message, usually after waiting for congestion
          to clear.</li>

          <li>A return result of <code>true</code> indicates that the
          message was accepted to be sent and possibly sent sucessfully.
          <b>It does not generally imply that the destination will
          successfully receive the message.</b></li>
      </ul>
  </li>

  <li>Synchronous Messengers:
      <ul>
          <li>A return result of <code>true</code> indicates that the message
          was successfully sent. <b>It does not generally imply that the
          destination will successfully receive the message.</b></li>
 </ul></li>

  <li>Asynchronous Messengers:
      <ul>
          <li>A return result of <code>true</code> indicates that the
          message was accepted to be sent. <b>It does not imply that the
          message will be sent or that the destination will receive the
          message.</b> There will be no notification of any errors in
          sending the message.</li>
 </ul></li>
  </ul></TD>
</TR>
</TABLE>
&nbsp;<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">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_net.jxta.endpoint.Messenger"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface net.jxta.endpoint.<A HREF="../../../../net/jxta/endpoint/Messenger.html" title="interface in net.jxta.endpoint">Messenger</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/jxta/endpoint/Messenger.html#hashCode()">hashCode</A>, <A HREF="../../../../net/jxta/endpoint/Messenger.html#isSynchronous()">isSynchronous</A>, <A HREF="../../../../net/jxta/endpoint/Messenger.html#sendMessage(net.jxta.endpoint.Message, java.lang.String, java.lang.String)">sendMessage</A>, <A HREF="../../../../net/jxta/endpoint/Messenger.html#sendMessage(net.jxta.endpoint.Message, java.lang.String, java.lang.String, net.jxta.endpoint.OutgoingMessageEventListener)">sendMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="closed"><!-- --></A><H3>
closed</H3>
<PRE>
protected volatile boolean <B>closed</B></PRE>
<DL>
<DD>If true then the messenger is closed
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="dstAddress"><!-- --></A><H3>
dstAddress</H3>
<PRE>
protected <A HREF="../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A> <B>dstAddress</B></PRE>
<DL>
<DD>The destination address of messages sent on this messenger.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="propertyChangeSupport"><!-- --></A><H3>
propertyChangeSupport</H3>
<PRE>
protected java.beans.PropertyChangeSupport <B>propertyChangeSupport</B></PRE>
<DL>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="BasicMessenger(net.jxta.endpoint.EndpointAddress)"><!-- --></A><H3>
BasicMessenger</H3>
<PRE>
public <B>BasicMessenger</B>(<A HREF="../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A>&nbsp;dest)</PRE>
<DL>
<DD>Create a new basic messenger.
<P>
<DT><B>Parameters:</B><DD><CODE>dest</CODE> - who messages should be addressed to</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public final boolean <B>equals</B>(java.lang.Object&nbsp;target)</PRE>
<DL>
<DD>

  <p/><A HREF="../../../../net/jxta/impl/endpoint/BasicMessenger.html#equals(java.lang.Object)"><CODE>equals(Object)</CODE></A> for messengers follows the contract that
  different messenger objects are <b>NEVER</b> equal.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/Messenger.html#equals(java.lang.Object)">equals</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/endpoint/Messenger.html" title="interface in net.jxta.endpoint">Messenger</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>Close this messenger after processing any pending messages. Messengers
  which manage shared resources internally may ignore this operation.
  Specifically:

  <p/><code><pre>
      messenger.close();
      closed = messenger.isClosed();
  </pre></code>

  <p/><code>closed</code> may be <code>false</code>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html" title="interface in net.jxta.endpoint">EndpointMessenger</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDestinationAddress()"><!-- --></A><H3>
getDestinationAddress</H3>
<PRE>
public <A HREF="../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A> <B>getDestinationAddress</B>()</PRE>
<DL>
<DD>Returns the destination of this messenger. The returned EndpointAddress 
  is a clone and can be freely used by the caller.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html#getDestinationAddress()">getDestinationAddress</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html" title="interface in net.jxta.endpoint">EndpointMessenger</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>EndpointAddress the destination address of this messenger<DT><B>See Also:</B><DD><A HREF="../../../../net/jxta/endpoint/Messenger.html#getLogicalDestinationAddress()"><CODE>Messenger.getLogicalDestinationAddress()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getDestinationAddressObject()"><!-- --></A><H3>
getDestinationAddressObject</H3>
<PRE>
public <A HREF="../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A> <B>getDestinationAddressObject</B>()</PRE>
<DL>
<DD>Returns the internal EndpointAddress object of the
  destination of the user. Changing the content of the
  object may have unpredictable consequence on the behavior
  of the EndpointMessenger. This method is intended to be
  used for applications that requires to have weak or soft
  reference to an EndpointMessenger: the returned Endpoint
  Address object will be unreferenced when this messenger
  will finalize.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html#getDestinationAddressObject()">getDestinationAddressObject</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html" title="interface in net.jxta.endpoint">EndpointMessenger</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>EndpointAddress the destination address of this messenger<DT><B>See Also:</B><DD><CODE>#getLogicalDestinationAddressObject()</CODE></DL>
</DD>
</DL>