netwerk/base/public/nsISocketTransportService.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsISocketTransport;
  41 interface nsIProxyInfo;
  42 interface nsIRunnable;
  43
  44 %{C++
  45 class nsASocketHandler;
  46 struct PRFileDesc;
  47 %}
  48
  49 [ptr] native PRFileDescPtr(PRFileDesc);
  50 [ptr] native nsASocketHandlerPtr(nsASocketHandler);
  51
  52 [scriptable, uuid(185B3A5D-8729-436D-9693-7BDCCB9C2216)]
  53 interface nsISocketTransportService : nsISupports
  54 {
  55     /**
  56      * Creates a transport for a specified host and port.
  57      *
  58      * @param aSocketTypes
  59      *        array of socket type strings.  null if using default socket type.
  60      * @param aTypeCount
  61      *        specifies length of aSocketTypes.
  62      * @param aHost
  63      *        specifies the target hostname or IP address literal of the peer
  64      *        for this socket.
  65      * @param aPort
  66      *        specifies the target port of the peer for this socket.
  67      * @param aProxyInfo
  68      *        specifies the transport-layer proxy type to use.  null if no
  69      *        proxy.  used for communicating information about proxies like
  70      *        SOCKS (which are transparent to upper protocols).
  71      *
  72      * @see nsIProxiedProtocolHandler
  73      * @see nsIProtocolProxyService::GetProxyInfo
  74      *
  75      * NOTE: this function can be called from any thread
  76      */
  77     nsISocketTransport createTransport([array, size_is(aTypeCount)]
  78                                        in string aSocketTypes,
  79                                        in unsigned long aTypeCount,
  80                                        in AUTF8String aHost,
  81                                        in long aPort,
  82                                        in nsIProxyInfo aProxyInfo);
  83
  84     /**
  85      * Adds a new socket to the list of controlled sockets.
  86      *
  87      * This will fail with the error code NS_ERROR_NOT_AVAILABLE if the maximum
  88      * number of sockets is already reached.
  89      * In this case, the notifyWhenCanAttachSocket method should be used.
  90      *
  91      * @param aFd
  92      *        Open file descriptor of the socket to control.
  93      * @param aHandler
  94      *        Socket handler that will receive notifications when the socket is
  95      *        ready or detached.
  96      *
  97      * NOTE: this function may only be called from an event dispatch on the
  98      *       socket thread.
  99      */
 100     [noscript] void attachSocket(in PRFileDescPtr aFd,
 101                                  in nsASocketHandlerPtr aHandler);
 102
 103     /**
 104      * if the number of sockets reaches the limit, then consumers can be
 105      * notified when the number of sockets becomes less than the limit.  the
 106      * notification is asynchronous, delivered via the given nsIRunnable
 107      * instance on the socket transport thread.
 108      *
 109      * @param aEvent
 110      *        Event that will receive the notification when a new socket can
 111      *        be attached
 112      *
 113      * NOTE: this function may only be called from an event dispatch on the
 114      *       socket thread.
 115      */
 116     [noscript] void notifyWhenCanAttachSocket(in nsIRunnable aEvent);
 117 };