followup to bug 418535, add comments about which threads nsISocketTransportService functions can be called on patch by Florian Quèze <florian@queze.net> r+sr=biesi
authorcbiesinger@gmail.com
Tue, 18 Mar 2008 14:00:53 -0700
changeset 13267 3d4062588c0f5187e90cd962c70750c62c03f18a
parent 13266 9f4d8d7f95304bf1679634e7ff093a5b1a9782cb
child 13268 8b221046239687158d93c9185a34683378efbb3f
push idunknown
push userunknown
push dateunknown
bugs418535
milestone1.9b5pre
followup to bug 418535, add comments about which threads nsISocketTransportService functions can be called on patch by Florian Quèze <florian@queze.net> r+sr=biesi
netwerk/base/public/nsISocketTransportService.idl
--- a/netwerk/base/public/nsISocketTransportService.idl
+++ b/netwerk/base/public/nsISocketTransportService.idl
@@ -66,16 +66,18 @@ interface nsISocketTransportService : ns
      *        specifies the target port of the peer for this socket.
      * @param aProxyInfo
      *        specifies the transport-layer proxy type to use.  null if no
      *        proxy.  used for communicating information about proxies like
      *        SOCKS (which are transparent to upper protocols).
      * 
      * @see nsIProxiedProtocolHandler
      * @see nsIProtocolProxyService::GetProxyInfo
+     *
+     * NOTE: this function can be called from any thread
      */
     nsISocketTransport createTransport([array, size_is(aTypeCount)]
                                        in string aSocketTypes,
                                        in unsigned long aTypeCount,
                                        in AUTF8String aHost, 
                                        in long aPort,
                                        in nsIProxyInfo aProxyInfo);
 
@@ -102,11 +104,14 @@ interface nsISocketTransportService : ns
      * if the number of sockets reaches the limit, then consumers can be
      * notified when the number of sockets becomes less than the limit.  the
      * notification is asynchronous, delivered via the given nsIRunnable
      * instance on the socket transport thread.
      *
      * @param aEvent
      *        Event that will receive the notification when a new socket can
      *        be attached
+     *
+     * NOTE: this function may only be called from an event dispatch on the
+     *       socket thread.
      */
     [noscript] void notifyWhenCanAttachSocket(in nsIRunnable aEvent);
 };