sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/pipe/InputPipe.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  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.
  15  *
  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.
  21  *
  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.
  26  *
  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.
  29  *
  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.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  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.
  47  *
  48  *  ====================================================================
  49  *
  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.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.pipe;
  58
  59
  60 import net.jxta.id.ID;
  61 import net.jxta.endpoint.Message;
  62 import net.jxta.protocol.PipeAdvertisement;
  63
  64
  65 /**
  66  * InputPipe defines the interface for receiving messages from a
  67  * {@link net.jxta.pipe.PipeService}.
  68  *
  69  * <p/>An application that wants to receive messages from a Pipe will create
  70  * an input pipe.
  71  *
  72  * <p/>An InputPipe is created and returned by the
  73  * {@link net.jxta.pipe.PipeService}
  74  *
  75  * @see    net.jxta.pipe.PipeService
  76  * @see    net.jxta.pipe.OutputPipe
  77  * @see    net.jxta.endpoint.Message
  78  * @see    net.jxta.endpoint.MessageElement
  79  * @see    net.jxta.protocol.PipeAdvertisement
  80  */
  81 public interface InputPipe {
  82
  83     /**
  84      * Wait (block) for a message to be received.
  85      *
  86      * @return                           a message or null if the pipe has been closed.
  87      * @exception  InterruptedException  If another thread interrupted while we
  88      * were waiting for a message.
  89      */
  90     public Message waitForMessage() throws InterruptedException;
  91
  92     /**
  93      * Poll for a message from the pipe. If there is no message immediately
  94      * available then wait the specified amount of time for a message to arrive.
  95      *
  96      * @param  timeout                Maximum number of milliseconds to wait (block) for a
  97      *  message to be received. If zero then wait indefinitely for a message.
  98      * @return                        Message received or null if the pipe has closed or the timeout
  99      * expired without a message being received.
 100      * @throws  InterruptedException  If another thread interrupted while we
 101      * were waiting for a message.
 102      */
 103     public Message poll(int timeout) throws InterruptedException;
 104
 105     /**
 106      * Close the pipe. No additional messages will be received on this pipe.
 107      */
 108     public void close();
 109
 110     /**
 111      *  Gets the pipe type
 112      *
 113      * @return    The type
 114      */
 115     public String getType();
 116
 117     /**
 118      *  Gets the pipe id
 119      *
 120      * @return    The type
 121      */
 122     public ID getPipeID();
 123
 124     /**
 125      *  Gets the pipe name
 126      *
 127      * @return    The name
 128      */
 129     public String getName();
 130
 131     /**
 132      *  Gets the pipe advertisement
 133      *
 134      * @return    The advertisement
 135      */
 136     public PipeAdvertisement getAdvertisement();
 137 }
 138