netwerk/base/src/nsTransportUtils.cpp

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla.
  15  *
  16  * The Initial Developer of the Original Code is IBM Corporation.
  17  * Portions created by IBM Corporation are Copyright (C) 2003
  18  * IBM Corporation. All Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *   IBM Corp.
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsTransportUtils.h"
  38 #include "nsITransport.h"
  39 #include "nsProxyRelease.h"
  40 #include "nsThreadUtils.h"
  41 #include "nsAutoLock.h"
  42 #include "nsAutoPtr.h"
  43 #include "nsCOMPtr.h"
  44
  45 //-----------------------------------------------------------------------------
  46
  47 class nsTransportStatusEvent;
  48
  49 class nsTransportEventSinkProxy : public nsITransportEventSink
  50 {
  51 public:
  52     NS_DECL_ISUPPORTS
  53     NS_DECL_NSITRANSPORTEVENTSINK
  54
  55     nsTransportEventSinkProxy(nsITransportEventSink *sink,
  56                               nsIEventTarget *target,
  57                               PRBool coalesceAll)
  58         : mSink(sink)
  59         , mTarget(target)
  60         , mLock(PR_NewLock())
  61         , mLastEvent(nsnull)
  62         , mCoalesceAll(coalesceAll)
  63     {
  64         NS_ADDREF(mSink);
  65     }
  66
  67     virtual ~nsTransportEventSinkProxy()
  68     {
  69         if (mLock)
  70             PR_DestroyLock(mLock);
  71
  72         // our reference to mSink could be the last, so be sure to release
  73         // it on the target thread.  otherwise, we could get into trouble.
  74         NS_ProxyRelease(mTarget, mSink);
  75     }
  76
  77     nsITransportEventSink           *mSink;
  78     nsCOMPtr<nsIEventTarget>         mTarget;
  79     PRLock                          *mLock;
  80     nsTransportStatusEvent          *mLastEvent;
  81     PRBool                           mCoalesceAll;
  82 };
  83
  84 class nsTransportStatusEvent : public nsRunnable
  85 {
  86 public:
  87     nsTransportStatusEvent(nsTransportEventSinkProxy *proxy,
  88                            nsITransport *transport,
  89                            nsresult status,
  90                            PRUint64 progress,
  91                            PRUint64 progressMax)
  92         : mProxy(proxy)
  93         , mTransport(transport)
  94         , mStatus(status)
  95         , mProgress(progress)
  96         , mProgressMax(progressMax)
  97     {}
  98
  99     ~nsTransportStatusEvent() {}
 100
 101     NS_IMETHOD Run()
 102     {
 103         // since this event is being handled, we need to clear the proxy's ref.
 104         // if not coalescing all, then last event may not equal self!
 105         {
 106             nsAutoLock lock(mProxy->mLock);
 107             if (mProxy->mLastEvent == this)
 108                 mProxy->mLastEvent = nsnull;
 109         }
 110
 111         mProxy->mSink->OnTransportStatus(mTransport, mStatus, mProgress,
 112                                          mProgressMax);
 113         return nsnull;
 114     }
 115
 116     nsRefPtr<nsTransportEventSinkProxy> mProxy;
 117
 118     // parameters to OnTransportStatus
 119     nsCOMPtr<nsITransport> mTransport;
 120     nsresult               mStatus;
 121     PRUint64               mProgress;
 122     PRUint64               mProgressMax;
 123 };
 124
 125 NS_IMPL_THREADSAFE_ISUPPORTS1(nsTransportEventSinkProxy, nsITransportEventSink)
 126
 127 NS_IMETHODIMP
 128 nsTransportEventSinkProxy::OnTransportStatus(nsITransport *transport,
 129                                              nsresult status,
 130                                              PRUint64 progress,
 131                                              PRUint64 progressMax)
 132 {
 133     nsresult rv = NS_OK;
 134     nsRefPtr<nsTransportStatusEvent> event;
 135     {
 136         nsAutoLock lock(mLock);
 137
 138         // try to coalesce events! ;-)
 139         if (mLastEvent && (mCoalesceAll || mLastEvent->mStatus == status)) {
 140             mLastEvent->mStatus = status;
 141             mLastEvent->mProgress = progress;
 142             mLastEvent->mProgressMax = progressMax;
 143         }
 144         else {
 145             event = new nsTransportStatusEvent(this, transport, status,
 146                                                progress, progressMax);
 147             if (!event)
 148                 rv = NS_ERROR_OUT_OF_MEMORY;
 149             mLastEvent = event;  // weak ref
 150         }
 151     }
 152     if (event) {
 153         rv = mTarget->Dispatch(event, NS_DISPATCH_NORMAL);
 154         if (NS_FAILED(rv)) {
 155             NS_WARNING("unable to post transport status event");
 156
 157             nsAutoLock lock(mLock); // cleanup.. don't reference anymore!
 158             mLastEvent = nsnull;
 159         }
 160     }
 161     return rv;
 162 }
 163
 164 //-----------------------------------------------------------------------------
 165
 166 nsresult
 167 net_NewTransportEventSinkProxy(nsITransportEventSink **result,
 168                                nsITransportEventSink *sink,
 169                                nsIEventTarget *target,
 170                                PRBool coalesceAll)
 171 {
 172     *result = new nsTransportEventSinkProxy(sink, target, coalesceAll);
 173     if (!*result)
 174         return NS_ERROR_OUT_OF_MEMORY;
 175     NS_ADDREF(*result);
 176     return NS_OK;
 177 }