messenger.html

jxta的api库

<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>
</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>
<DD><DL>
</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="isSynchronous()"><!-- --></A><H3>
isSynchronous</H3>
<PRE>
public boolean <B>isSynchronous</B>()</PRE>
<DL>
<DD>Returns <code>true</code> if the <code>sendMessage</code> methods of
  this messenger are fully synchronous. If this messenger is syncrhonous
  then it should be understood that <code>sendMessage</code> methods may :

  <p/><ul>
      <li>Not return until the message is fully sent.</li>
      <li>Block if another message is in the process of being sent.</li>
  </ul>

  <p/>If either of these conditions can occur then this method will
  return <code>true</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="sendMessage(net.jxta.endpoint.Message, java.lang.String, java.lang.String)"><!-- --></A><H3>
sendMessage</H3>
<PRE>
public boolean <B>sendMessage</B>(<A HREF="../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;msg,
                           java.lang.String&nbsp;service,
                           java.lang.String&nbsp;serviceParam)
                    throws java.io.IOException</PRE>
<DL>
<DD>Sends a message to the destination. The message will be sent to the
  location specified by the destination endpoint address. The destination
  address will be modified to include the provided optional service name
  and service parameter.

  <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 messanger 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>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>
      </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>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The message to send.<DD><CODE>service</CODE> - Optionally replaces the service in the destination
  address. If <code>null</code> then the destination address's default
  service will be used.  If the empty string ("") is used then
  no service is included in the destination address.<DD><CODE>serviceParam</CODE> - Optionally replaces the service param in the
  destination address. If <code>null</code> then the destination address's
  default service parameter will be used. If the empty string ("") is used
  then no service param is included in the destination address.
<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="sendMessage(net.jxta.endpoint.Message, java.lang.String, java.lang.String, net.jxta.endpoint.OutgoingMessageEventListener)"><!-- --></A><H3>
sendMessage</H3>
<PRE>
public void <B>sendMessage</B>(<A HREF="../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;msg,
                        java.lang.String&nbsp;service,
                        java.lang.String&nbsp;serviceParam,
                        <A HREF="../../../net/jxta/endpoint/OutgoingMessageEventListener.html" title="interface in net.jxta.endpoint">OutgoingMessageEventListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Sends a message to the destination. The message will be sent to the
  location specified by the destination endpoint address. The destination
  address will be modified to include the provided optional service name
  and service parameter.

  <p/><b>WARNING:</b> The Message object should not be reused or modified
  until the sendMessage has completed. Concurrent modification of messages
  while a messenger is sending a message will produce incorrect and
  unpredictable results. Messages should either be cloned before sending
  or not modified until the sendMessage result is returned.

  <p/>Error Handling:

  <ul>
  <li>Common Aspects:
      <ul>
          <li>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>isClosed()</CODE></A>.
          </li>
          <li>Notification of the final state of the message will be
          returned via the optional
          <A HREF="../../../net/jxta/endpoint/OutgoingMessageEventListener.html" title="interface in net.jxta.endpoint"><CODE>listener</CODE></A>.</li>
      </ul></li>

  <li>Synchronous Messengers:
      <ul>
          <li>The listener will always be called before
          <code>sendMessage</code> returns.</li>
      </ul>
  </li>
  </ul>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The message to send.<DD><CODE>service</CODE> - Optionally replaces the service in the destination
  address. If <code>null</code> then the destination address's default
  service will be used.  If the empty string ("") is used then
  no service is included in the destination address.<DD><CODE>serviceParam</CODE> - Optionally replaces the service param in the
  destination address. If <code>null</code> then the destination address's
  default service parameter will be used. If the empty string ("") is used
  then no service param is included in the destination address.<DD><CODE>listener</CODE> - listener for events about this message or null if
  no notification is desired.</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/Messenger.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/endpoint/MessageTransport.html" title="interface in net.jxta.endpoint"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../net/jxta/endpoint/MessengerEventListener.html" title="interface in net.jxta.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="Messenger.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>