sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/util/pipe/reliable/Outgoing.java

   1 /*
   2  * Copyright (c) 2003-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.impl.util.pipe.reliable;
  58
  59
  60 import java.io.IOException;
  61 import net.jxta.endpoint.Message;
  62
  63
  64 /**
  65  * This interface specifies the methods that must be
  66  * implemented by a connection in order to be able to
  67  * reliably deliver messages over the connection.
  68  */
  69 public interface Outgoing {
  70
  71     /**
  72      * Send a message to the remote peer.
  73      * @param msg the message
  74      * @return true is successful
  75      * @throws java.io.IOException if io error occurs
  76      */
  77     boolean send(Message msg) throws IOException;
  78
  79     /**
  80      * Close the connection.
  81      */
  82     void close();
  83
  84     /**
  85      * Amount of a connection must be idle before a
  86      * reconnection attempt will be considered.
  87      * @return min idle reconnect time in millis
  88      */
  89     long getMinIdleReconnectTime();
  90
  91     /**
  92      *  Sets the Timeout attribute. A timeout of 0 blocks forever
  93      *
  94      * @param  timeout The new soTimeout value
  95      */
  96     void setTimeout(int timeout);
  97
  98     /**
  99      * Amount of time after which a connection is
 100      * considered idle and may be scavenged.
 101      * @return idle timeout in millis
 102      */
 103     long getIdleTimeout();
 104
 105     /**
 106      * Amount if time during which retries may remain
 107      * queued for retransmission. If still unACKed after
 108      * this amount of time then the connection is
 109      * considered dead.
 110      * @return max retry age in millis
 111      */
 112     long getMaxRetryAge();
 113
 114     /**
 115      * Get the time when this connection was last used.
 116      * @return last accessed in millis
 117      */
 118     long getLastAccessed();
 119
 120     /**
 121      * Set the time when this connection was last used.
 122      * @param time in millis
 123      */
 124     void setLastAccessed(long time);
 125 }