endpointprotocol.java

jxme的一些相关程序,主要是手机上程序开发以及手机和计算机通信的一些程序资料,程序编译需要Ant支持

/************************************************************************
 *
 * $Id: EndpointProtocol.java,v 1.2 2002/03/04 20:18:38 echtcherbina Exp $
 *
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA"
 *    must not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 *********************************************************************************/

package net.jxta.endpoint;

import net.jxta.protocol.EndpointAdvertisement;
import net.jxta.platform.Module;
import net.jxta.peergroup.PeerGroup;

import java.io.*;

/**
 * This interface defines the API that must implemented by all the
 * Endpoint Protocols.
 * <p>
 * @see net.jxta.endpoint.EndpointService
 * @see net.jxta.endpoint.EndpointAddress
 * @see net.jxta.endpoint.Message
 *
 * @since JXTA 1.0
 **/

public interface EndpointProtocol {

    /**
     * Creates and return an EndpointMessenger for sending Message's
     *
     * @param dest EndpointAddress of the destination
     * @return an EndpointMessenger. null is returned if the EndpointAddress is not
     * reachable.
     * @throws IOException when the Endpoint Transport was unable to create
     * an Endpoint Messenger for the given Endpoint Address.
     */
    public EndpointMessenger getMessenger (EndpointAddress dest)
        throws IOException;



    /**
     * Propagates a Message on this EndpointProtocol.
     *
     * @param msg the Message to be propagated
     * @param serviceName is a String containing the name of the service
     * @param serviceParams is a String containing the parameters associated
     * to the service. The combination of serviceName and serviceParams
     * is the what must have been registered to the EndpointService's demux.
     * @param prunePeer peer which should not receive the propagated message
     *
     * @throws IOException is thrown when the message could not be propagated.
     */
    public void propagate (Message msg,
                           String serviceName,
                           String serviceParams,
                           String prunePeer) throws IOException;

    /**
     * Returns true if this protocol accepts to be overloaded.
     * That is let a protocol with the same protocol name in a
     * descendant group be registered.
     *
     * @return boolean true if over load is allowed.
     */
    public boolean allowOverLoad();


    /**
     * Returns a String containing the canonical name of this
     * endpoint protocol, as it appears in an EndpointAddress.
     *
     * @return a String containing the name of the protocol
     */
    public String getProtocolName();

    /**
     * Returns an EndpointAddress of the local endpoint
     * managed by the EndpointProtocol. This is the address that
     * other peers (possibly on the other side of a NAT can use to connect to
     * this peer).
     *
     * @return an EndpointAddress containing the public address
     */
    public EndpointAddress getPublicAddress();

    /**
     * Returns true if the endpoint protocol can establish
     * connection to the remote host (like TCP).
     *
     * @return boolean true if the protocol is connection oriented.
     */
    public boolean isConnectionOriented();

    /**
     * Returns true if the endpoint protocol can be used by the EndpointRouter
     *
     * @return boolean true if the protocol can be used by the EndpointRouter
     */
    public boolean allowRouting();

    /**
     * Returns true if the target address is reachable. Otherwise
     * returns false.
     *
     * @return boolean true if this protocol claims it can reach the given
     * address.
     */
    public boolean ping (EndpointAddress addr);
}