/*
 * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
 *  
 *  The Sun Project JXTA(TM) Software License
 *  
 *  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 Sun Microsystems, Inc. for JXTA(TM) technology." 
 *     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.
 *  
 *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United 
 *  States and other countries.
 *  
 *  Please see the license information page at :
 *  <http://www.jxta.org/project/www/license.html> for instructions on use of 
 *  the license in source files.
 *  
 *  ====================================================================
 *  
 *  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 net.jxta.endpoint.Message;
import net.jxta.id.ID;
import net.jxta.protocol.PipeAdvertisement;


/**
 * InputPipe defines the interface for receiving messages from a
 * {@link net.jxta.pipe.PipeService}.
 *
 * <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
 * {@link net.jxta.pipe.PipeService}
 *
 * @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
 */
public interface InputPipe {

    /**
     * Wait (block) for a message to be received.
     *
     * @return                           a message or null if the pipe has been closed.
     * @exception  InterruptedException  If another thread interrupted while we
     * were waiting for a message.
     */
    public Message waitForMessage() throws InterruptedException;

    /**
     * Poll for a message from the pipe. If there is no message immediately
     * available then wait the specified amount of time for a message to arrive.
     *
     * @param  timeout                Maximum number of milliseconds to wait (block) for a
     *  message to be received. If zero then wait indefinitely for a message.
     * @return                        Message received or null if the pipe has closed or the timeout
     * expired without a message being received.
     * @throws  InterruptedException  If another thread interrupted while we
     * were waiting for a message.
     */
    public Message poll(int timeout) throws InterruptedException;

    /**
     * Close the pipe. No additional messages will be received on this pipe.
     */
    public void close();

    /**
     *  Gets the pipe type
     *
     * @return    The type
     */
    public String getType();

    /**
     *  Gets the pipe id
     *
     * @return    The type
     */
    public ID getPipeID();

    /**
     *  Gets the pipe name
     *
     * @return    The name
     */
    public String getName();

    /**
     *  Gets the pipe advertisement
     *
     * @return    The advertisement
     */
    public PipeAdvertisement getAdvertisement();
}