2 * Copyright (c) 2001-2007 Sun Microsystems, Inc. All rights reserved.
4 * The Sun Project JXTA(TM) Software License
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
16 * 3. The end-user documentation included with the redistribution, if any, must
17 * include the following acknowledgment: "This product includes software
18 * developed by Sun Microsystems, Inc. for JXTA(TM) technology."
19 * Alternately, this acknowledgment may appear in the software itself, if
20 * and wherever such third-party acknowledgments normally appear.
22 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
23 * not be used to endorse or promote products derived from this software
24 * without prior written permission. For written permission, please contact
25 * Project JXTA at http://www.jxta.org.
27 * 5. Products derived from this software may not be called "JXTA", nor may
28 * "JXTA" appear in their name, without prior written permission of Sun.
30 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
32 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
33 * MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
34 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
36 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
37 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
38 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
39 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * JXTA is a registered trademark of Sun Microsystems, Inc. in the United
42 * States and other countries.
44 * Please see the license information page at :
45 * <http://www.jxta.org/project/www/license.html> for instructions on use of
46 * the license in source files.
48 * ====================================================================
50 * This software consists of voluntary contributions made by many individuals
51 * on behalf of Project JXTA. For more information on Project JXTA, please see
52 * http://www.jxta.org.
54 * This license is based on the BSD license adopted by the Apache Foundation.
57 package net.jxta.endpoint;
61 * A MessagePropagater is a MessageTransport that can send propagated
62 * (multicast) messages.
64 * @see net.jxta.endpoint.MessageTransport
65 * @see net.jxta.endpoint.Message
66 * @see net.jxta.endpoint.Messenger
67 * @see net.jxta.endpoint.EndpointService
68 * @see net.jxta.endpoint.MessageSender
69 * @see net.jxta.endpoint.MessageReceiver
71 public interface MessagePropagater extends MessageTransport {
74 * Returns the {@link EndpointAddress} which will be used as the source
75 * address for all messages sent by this message sender. This is the
76 * "preferred" address to which replies should be sent. This address is not
77 * necessarily the best or only address by which the peer may be reached.
79 * The public address may also be for a different message transport.
81 * @return an EndpointAddress containing the public address for this
84 public EndpointAddress getPublicAddress();
87 * Propagates a Message via this Message Transport.
89 * @param msg The Message to be propagated.
90 * @param serviceName Contains the name of the destination service, if any.
91 * This will be integrated into the destination address.
92 * @param serviceParams Contains the parameters associated with the service,
93 * if any. This will be integrated into the destination address.
94 * @param initialTTL The requested initial TTL for this message. This value
95 * may be reduced by the implementation.
96 * @return {@code true} if the Message was propagated otherwise
99 public boolean propagate(Message msg, String serviceName, String serviceParams, int initialTTL);