sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/util/pipe/reliable/OutgoingMsgrAdaptor.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 package net.jxta.impl.util.pipe.reliable;
  57
  58
  59 import java.io.IOException;
  60
  61 import net.jxta.endpoint.Message;
  62 import net.jxta.endpoint.Messenger;
  63 import net.jxta.impl.util.TimeUtils;
  64
  65 import java.util.logging.Level;
  66 import net.jxta.logging.Logging;
  67 import java.util.logging.Logger;
  68
  69
  70 /**
  71  *  OutgoingMessengerAdaptor
  72  */
  73 public class OutgoingMsgrAdaptor implements Outgoing {
  74
  75     private final static transient Logger LOG = Logger.getLogger(OutgoingMsgrAdaptor.class.getName());
  76
  77     private final Messenger msgr;
  78     private int timeout;
  79     private long lastAccessed = 0;
  80     private boolean closed = false;
  81
  82     /**
  83      *  Constructor for the OutgoingMsgrAdaptor object
  84      *
  85      *@param  msgr     the messenger used to send messages
  86      *@param  timeout  timeout in milliseconds
  87      */
  88     public OutgoingMsgrAdaptor(Messenger msgr, int timeout) {
  89         if (msgr == null) {
  90             throw new IllegalArgumentException("messenger cannot be null");
  91         }
  92         this.msgr = msgr;
  93         this.timeout = timeout;
  94
  95         // initialize to some reasonable value
  96         lastAccessed = TimeUtils.timeNow();
  97     }
  98
  99     /**
 100      *  returns last accessed time as a string
 101      *
 102      *@return    last accessed time as a string
 103      */
 104     @Override
 105     public String toString() {
 106         return " lastAccessed=" + Long.toString(lastAccessed);
 107     }
 108
 109     /**
 110      *  Sets the Timeout attribute. A timeout of 0 blocks forever
 111      *
 112      * @param  timeout The new soTimeout value
 113      */
 114     public void setTimeout(int timeout) {
 115         this.timeout = timeout;
 116     }
 117
 118     /**
 119      *  close the messenger (does not close the messenger)
 120      */
 121     public void close() {
 122         closed = true;
 123     }
 124
 125     /**
 126      *  Gets the minIdleReconnectTime of the OutgoingMsgrAdaptor
 127      *  (obsolete).
 128      *@return    The minIdleReconnectTime value
 129      */
 130     public long getMinIdleReconnectTime() {
 131         return timeout;
 132     }
 133
 134     /**
 135      *  Gets the idleTimeout of the OutgoingMsgrAdaptor. The adaptor never times out.
 136      *@return    <code>Long.MAX_VALUE</code>
 137      */
 138     public long getIdleTimeout() {
 139         return Long.MAX_VALUE;
 140     }
 141
 142     /**
 143      *  Gets the maxRetryAge attribute of the OutgoingMsgrAdaptor
 144      *
 145      *@return    The maxRetryAge value
 146      */
 147     public long getMaxRetryAge() {
 148         return timeout == 0 ? Long.MAX_VALUE : timeout;
 149     }
 150
 151     /**
 152      *  Gets the lastAccessed time of OutgoingMsgrAdaptor
 153      *
 154      *@return    The lastAccessed in milliseconds
 155      */
 156     public long getLastAccessed() {
 157         return lastAccessed;
 158     }
 159
 160     /**
 161      *  Sets the lastAccessed of OutgoingMsgrAdaptor
 162      *
 163      *@param  time  The new lastAccessed in milliseconds
 164      */
 165     public void setLastAccessed(long time) {
 166         if (Logging.SHOW_FINE && LOG.isLoggable(Level.FINE)) {
 167             LOG.fine("Setting lastAccessed to :" + lastAccessed);
 168         }
 169         lastAccessed = time;
 170     }
 171
 172     /**
 173      *  Sends a message
 174      *
 175      *@param  msg              message to send
 176      *@return                  true if message send is successful
 177      *@exception  IOException  if an io error occurs
 178      */
 179     public boolean send(Message msg) throws IOException {
 180         if (closed) {
 181             throw new IOException("broken connection");
 182         }
 183
 184         if (Logging.SHOW_FINE && LOG.isLoggable(Level.FINE)) {
 185             LOG.fine("Sending a Message");
 186         }
 187
 188         msgr.sendMessageB(msg, null, null);
 189         return true;
 190     }
 191 }
 192