inputpipe.java

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

/*
 * $Id: InputPipe.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.io.IOException;
import net.jxta.endpoint.Message;

/**
 * InputPipe defines the interface for receiving messages from a
 * <b>PipeService</b>.
 * <p>
 * An application that wants to receive messages from a Pipe will create
 * an input pipe.
 * <p>
 * An InputPipe is created and returned by the <b>PipeService</P>
 * <p>
 * @see net.jxta.pipe.PipeService
 * @see net.jxta.pipe.OutputPipe
 * @see net.jxta.endpoint.Message
 * @see net.jxta.endpoint.MessageElement
 * @see net.jxta.protocol.PipeAdvertisement
 * @see net.jxta.resolver.GenericResolver
 *
 *  @since JXTA 1.0
 */

public interface InputPipe {

  /**
   * wait for a message to be received
   *
   * @return Message  message received
   * @exception InterruptedException If another thread interrupted while we
   *  were waiting for a message.
   *
   * @since JXTA 1.0
   */

  public Message waitForMessage() throws InterruptedException;

  /**
   * Poll for a message from the pipe. If there is no message available then
   * wait the specified amount of time. if Timeout is zero then wait
   * indefinitely.
   *
   * @param timeout minimum time poll is supposed to block (in milliseconds)
   * @return Message message received or null if the pipe has closed or the
   * timeout expires without a message being delivered.
   *
   * @exception InterruptedException If another thread interrupted while we
   *  were waiting for a message.
   *
   * @since JXTA 1.0
   */

  public Message poll(int timeout) throws InterruptedException;

  /**
   * close the pipe
   *
   * @since JXTA 1.0
   */
  public void close();

}