pipeservice.java

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

/*
 *
 * $Id: PipeService.java,v 1.2 2002/03/04 20:19:21 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.pipe;

import java.util.Enumeration;
import java.io.IOException;

import net.jxta.service.Service;
import net.jxta.protocol.PipeAdvertisement;
import net.jxta.endpoint.Message;

/**
 *
 * This class defines the API to the JXTA Pipe Service.
 * <p>
 * Pipes are the core mechanism for exchanging messages
 * between two JXTA applications or services.
 *
 * <p>Pipes are uniquely identified by a  <b>PipeAdvertisement</b> which
 * is associated with each pipe. Creating the advertisement of a Pipe must
 * be done only once in the lifetime of a Pipe. In fact, a <b>PipeAdvertisement</b>
 * represents the pipe on the JXTA network.
 * <p>
 * Several types of Pipe can be used:
 * <ul>
 * <li> <b>JxtaUnicast</b>: unicast, unreliable and unsecure pipe
 * <li> <b>JxtaUnicastSecure</b>: unicast and secure pipe
 * <li> <b>JxtaPropagate</b>: propagated, unreliable and unsecure pipe
 * </ul>
 * The type of a Pipe is defined when creating its <b>PipeAdvertisement</b>.
 *
 * @see net.jxta.protocol.PipeAdvertisement
 * @see net.jxta.pipe.InputPipe
 * @see net.jxta.pipe.OutputPipe
 * @see net.jxta.endpoint.Message
 *
 * @since JXTA 1.0
 */

public interface PipeService extends Service {

    /**
     *  PipeService Types definition.
     *
     *       UnicastType: basic unicast pipe
     *     PropagateType: propgated pipe
     * UnicastSecureType: end-to-end secured unicast pipe
     *
     **/

    /**
     * Unicast, unreliable and unsecure type of Pipe
     **/
    public final static String UnicastType = "JxtaUnicast";
    /**
     * Propagated, unsecure and unreliable type of Pipe
     **/
    public final static String PropagateType = "JxtaPropagate";
    /**
     * Unicast and secure type of Pipe
     **/
    public final static String UnicastSecureType = "JxtaUnicastSecure";


    /**
     * create an InputPipe from a pipe Advertisement
     *
     * @param adv is the advertisement of the PipeService.
     * @return InputPipe InputPipe object created
     *
     * @exception IOException error creating input pipe
     *
     * @since JXTA 1.0
     */

    public InputPipe createInputPipe (PipeAdvertisement adv)
	throws IOException;

    /**
     * create an InputPipe from a pipe Advertisement
     *
     * @param adv is the advertisement of the PipeService.
     * @param listener PipeMsgListener to receive msgs.
     * @return InputPipe InputPipe object created
     *
     * @exception IOException error creating input pipe
     *
     * @since JXTA 1.0
     */

    public InputPipe createInputPipe (PipeAdvertisement adv, PipeMsgListener listener)
	throws IOException;

    /**
     * create an OutputPipe from the pipe Advertisement
     *
     * @param adv is the advertisement of the PipeService.
     * @param timeout time createOutputPipe will block: -1 means indefinitely,
     *  otherwise, timeout in millisecond
     * @return OuputPipe Output pip object
     *
     * @exception IOException error creating output pipe
     *
     * @since JXTA 1.0
     */

    public OutputPipe createOutputPipe (PipeAdvertisement adv, long timeout)
	throws IOException;

    /**
     * registers a listener for a NetPipe.
     *
     * @param adv is the advertisement of the PipeService.
     * @param type is an int and contains the name of the diffusion mode for
     * this OutputPipe (NonBlocking, HandChecking, Propagate).
     * @param OutPutPipeListener listener to be called back when a pipe is resolved
     * @exception IOException error creating a listener for the type of output pipe
     * @since JXTA 1.0
     */

    public void createOutputPipe (PipeAdvertisement adv, OutputPipeListener listener)
	throws IOException;


    /**
     * create an OutputPipe from the pipe Advertisement giving a PeerId(s) where
     * the corresponding InputPipe is supposed to be.
     *
     * @param adv is the advertisement of the NetPipe.
     * @param peers is an enumeration of the PeerId of the peers where to look for the
     * corresponding Pipes
     * @param timeout time createOutputPipe will block: -1 means
     *        indefinitely, otherwise, timeout in millisecond
     * @return OuputPipe
     * @exception IOException if none of the peers in the enumeration has
     *                     the corresponding OutputPipe
     *
     * @since JXTA 1.0
     */

    public OutputPipe createOutputPipe (PipeAdvertisement adv, Enumeration peers, long timeout)
	throws IOException;


    /**
     * Creates a new Message
     *
     * @return Message returns a newly allocated PipeService Message.
     *
     * @since JXTA 1.0
     */

    public Message createMessage();

    /**
     *  remove a Output pipe listener
     *  @param  OutputPipeListener listener to remove
     *  @return OutputPipeListener the value to which the key had been
     *  mapped in this hashtable, or null if the key did not have a mapping.
     */

    public OutputPipeListener removeOutputPipeListener (String pipeID, OutputPipeListener listener);
}