basicmessenger.html

jxta的api库

<HR>

<A NAME="getLogicalDestinationAddress()"><!-- --></A><H3>
getLogicalDestinationAddress</H3>
<PRE>
public <A HREF="../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A> <B>getLogicalDestinationAddress</B>()</PRE>
<DL>
<DD>Returns the logical destination of this messenger. This may be a
  different address than is returned by
  <A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html#getDestinationAddress()"><CODE>getDestinationAddress</CODE></A> and refers to
  the entity which is located at the destination address.

  <p/>By analogy, a telephone number would be the destination address, and
  the owner of that telephone number would be the logical destination.
  Each logical destination may be known by one or more destination
  addresses.

 <p/>By default the logical destination is the same as the destination.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/Messenger.html#getLogicalDestinationAddress()">getLogicalDestinationAddress</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>

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

<A NAME="isClosed()"><!-- --></A><H3>
isClosed</H3>
<PRE>
public boolean <B>isClosed</B>()</PRE>
<DL>
<DD>Returns <code>true</code> if this messenger is closed and no longer 
  accepting messages to be sent. The messenger should be discarded.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/Messenger.html#isClosed()">isClosed</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>

<DT><B>Returns:</B><DD><code>true</code> if this messenger is closed, otherwise 
  <code>false</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="isIdle()"><!-- --></A><H3>
isIdle</H3>
<PRE>
public boolean <B>isIdle</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/Messenger.html#isIdle()">isIdle</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>

<DT><B>Returns:</B><DD><code>true</code> if the messenger is idle otherwise 
 <code>false</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="sendMessage(net.jxta.endpoint.Message)"><!-- --></A><H3>
sendMessage</H3>
<PRE>
public final boolean <B>sendMessage</B>(<A HREF="../../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;msg)
                          throws java.io.IOException</PRE>
<DL>
<DD>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>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/endpoint/EndpointMessenger.html#sendMessage(net.jxta.endpoint.Message)">sendMessage</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>Parameters:</B><DD><CODE>msg</CODE> - The message to send.
<DT><B>Returns:</B><DD>boolean <code>true</code> if the message has been sent otherwise
  <code>false</code>. <code>false</code>. is commonly returned for
  non-error related congestion, meaning that you should be able to send
  the message after waiting some amount of time.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - Thrown if the message cannot be sent.</DL>
</DD>
</DL>
<HR>

<A NAME="addPropertyChangeListener(java.beans.PropertyChangeListener)"><!-- --></A><H3>
addPropertyChangeListener</H3>
<PRE>
public void <B>addPropertyChangeListener</B>(java.beans.PropertyChangeListener&nbsp;listener)</PRE>
<DL>
<DD>{@inheritDoc}
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="removePropertyChangeListener(java.beans.PropertyChangeListener)"><!-- --></A><H3>
removePropertyChangeListener</H3>
<PRE>
public void <B>removePropertyChangeListener</B>(java.beans.PropertyChangeListener&nbsp;listener)</PRE>
<DL>
<DD>{@inheritDoc}
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDestAddressToUse(java.lang.String, java.lang.String)"><!-- --></A><H3>
getDestAddressToUse</H3>
<PRE>
protected <A HREF="../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A> <B>getDestAddressToUse</B>(java.lang.String&nbsp;service,
                                              java.lang.String&nbsp;serviceParam)</PRE>
<DL>
<DD>Constructs the destination address to use for given the specified
  service and param
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the service name which will be used in the destination address<DD><CODE>serviceParam</CODE> - the service param which will be used in the destination address.
<DT><B>Returns:</B><DD>the destination address for this messenger optionally modified by the provided params</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=3 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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BasicMessenger.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
JXTA J2SE</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../net/jxta/impl/endpoint/AdaptorNonBlockingMessenger.html" title="class in net.jxta.impl.endpoint"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../net/jxta/impl/endpoint/BlockingMessenger.html" title="class in net.jxta.impl.endpoint"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="BasicMessenger.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>