netwerk/base/src/nsTransportUtils.h

   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 #ifndef nsTransportUtils_h__
  38 #define nsTransportUtils_h__
  39
  40 #include "nsITransport.h"
  41
  42 /**
  43  * This function returns a proxy object for a transport event sink instance.
  44  * The transport event sink will be called on the thread indicated by the
  45  * given event target.  Like events are automatically coalesced.  This means
  46  * that for example if the status value is the same from event to event, and
  47  * the previous event has not yet been delivered, then only one event will
  48  * be delivered.  The progress reported will be that from the second event.
  49  * If aCoalesceAllEvents is true, then any undelivered event will be replaced
  50  * with the next event if it arrives early enough.  This option should be used
  51  * cautiously since it can cause states to be effectively skipped.  Coalescing
  52  * events can help prevent a backlog of unprocessed transport events in the
  53  * case that the target thread is overworked.
  54  */
  55 NS_HIDDEN_(nsresult)
  56 net_NewTransportEventSinkProxy(nsITransportEventSink **aResult,
  57                                nsITransportEventSink *aSink,
  58                                nsIEventTarget *aTarget,
  59                                PRBool aCoalesceAllEvents = PR_FALSE);
  60
  61 #endif // nsTransportUtils_h__