Bug 418535 - Make socket attachment to nsSocketTransportService usable from XPCOM. r+sr=biesi, a1.9=beltzner

netwerk/base/public/Makefile.in

@@ -139,6 +139,7 @@ EXPORTS		= \
 		nsReadLine.h \
 		nsCPasswordManager.h \
 		nsCPasswordManagerInternal.h \
+		nsASocketHandler.h \
 		$(NULL)
 
 PREF_JS_EXPORTS = $(srcdir)/security-prefs.js

netwerk/base/public/nsASocketHandler.h

@@ -0,0 +1,99 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is Mozilla.
+ *
+ * The Initial Developer of the Original Code is
+ * Netscape Communications Corporation.
+ * Portions created by the Initial Developer are Copyright (C) 2002
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Darin Fisher <darin@netscape.com>
+ *   Florian Queze <florian@queze.net>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+#ifndef nsASocketHandler_h__
+#define nsASocketHandler_h__
+
+// socket handler used by nsISocketTransportService.
+// methods are only called on the socket thread.
+
+class nsASocketHandler : public nsISupports
+{
+public:
+    nsASocketHandler()
+        : mCondition(NS_OK)
+        , mPollFlags(0)
+        , mPollTimeout(PR_UINT16_MAX)
+        {}
+
+    //
+    // this condition variable will be checked to determine if the socket
+    // handler should be detached.  it must only be accessed on the socket
+    // thread.
+    //
+    nsresult mCondition;
+
+    //
+    // these flags can only be modified on the socket transport thread.
+    // the socket transport service will check these flags before calling
+    // PR_Poll.
+    //
+    PRUint16 mPollFlags;
+
+    //
+    // this value specifies the maximum amount of time in seconds that may be
+    // spent waiting for activity on this socket.  if this timeout is reached,
+    // then OnSocketReady will be called with outFlags = -1.
+    //
+    // the default value for this member is PR_UINT16_MAX, which disables the
+    // timeout error checking.  (i.e., a timeout value of PR_UINT16_MAX is
+    // never reached.)
+    //
+    PRUint16 mPollTimeout;
+
+    //
+    // called to service a socket
+    // 
+    // params:
+    //   socketRef - socket identifier
+    //   fd        - socket file descriptor
+    //   outFlags  - value of PR_PollDesc::out_flags after PR_Poll returns
+    //               or -1 if a timeout occured
+    //
+    virtual void OnSocketReady(PRFileDesc *fd, PRInt16 outFlags) = 0;
+
+    //
+    // called when a socket is no longer under the control of the socket
+    // transport service.  the socket handler may close the socket at this
+    // point.  after this call returns, the handler will no longer be owned
+    // by the socket transport service.
+    //
+    virtual void OnSocketDetached(PRFileDesc *fd) = 0;
+};
+
+#endif // !nsASocketHandler_h__

netwerk/base/public/nsISocketTransportService.idl

@@ -39,8 +39,17 @@
 
 interface nsISocketTransport;
 interface nsIProxyInfo;
+interface nsIRunnable;
 
-[scriptable, uuid(7B19AC06-A5FB-11D9-9F82-0011246ECD24)]
+%{C++
+class nsASocketHandler;
+struct PRFileDesc;
+%}
+
+[ptr] native PRFileDescPtr(PRFileDesc);
+[ptr] native nsASocketHandlerPtr(nsASocketHandler);
+
+[scriptable, uuid(185B3A5D-8729-436D-9693-7BDCCB9C2216)]
 interface nsISocketTransportService : nsISupports 
 {
     /**
@@ -69,4 +78,35 @@ interface nsISocketTransportService : nsISupports
                                        in AUTF8String aHost, 
                                        in long aPort,
                                        in nsIProxyInfo aProxyInfo);
+
+    /**
+     * Adds a new socket to the list of controlled sockets.
+     *
+     * This will fail with the error code NS_ERROR_NOT_AVAILABLE if the maximum
+     * number of sockets is already reached.
+     * In this case, the notifyWhenCanAttachSocket method should be used.
+     *
+     * @param aFd
+     *        Open file descriptor of the socket to control.
+     * @param aHandler
+     *        Socket handler that will receive notifications when the socket is
+     *        ready or detached.
+     *
+     * NOTE: this function may only be called from an event dispatch on the
+     *       socket thread.
+     */
+    [noscript] void attachSocket(in PRFileDescPtr aFd,
+                                 in nsASocketHandlerPtr aHandler);
+
+    /**
+     * 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
+     */
+    [noscript] void notifyWhenCanAttachSocket(in nsIRunnable aEvent);
 };

netwerk/base/src/nsSocketTransportService2.cpp

@@ -133,7 +133,7 @@ nsSocketTransportService::IsOnCurrentThread(PRBool *result)
 //-----------------------------------------------------------------------------
 // socket api (socket thread only)
 
-nsresult
+NS_IMETHODIMP
 nsSocketTransportService::NotifyWhenCanAttachSocket(nsIRunnable *event)
 {
     LOG(("nsSocketTransportService::NotifyWhenCanAttachSocket\n"));
@@ -141,7 +141,6 @@ nsSocketTransportService::NotifyWhenCanAttachSocket(nsIRunnable *event)
     NS_ASSERTION(PR_GetCurrentThread() == gSocketThread, "wrong thread");
 
     if (CanAttachSocket()) {
-        NS_WARNING("should have called CanAttachSocket");
         return Dispatch(event, NS_DISPATCH_NORMAL);
     }
 
@@ -149,13 +148,17 @@ nsSocketTransportService::NotifyWhenCanAttachSocket(nsIRunnable *event)
     return NS_OK;
 }
 
-nsresult
+NS_IMETHODIMP
 nsSocketTransportService::AttachSocket(PRFileDesc *fd, nsASocketHandler *handler)
 {
     LOG(("nsSocketTransportService::AttachSocket [handler=%x]\n", handler));
 
     NS_ASSERTION(PR_GetCurrentThread() == gSocketThread, "wrong thread");
 
+    if (!CanAttachSocket()) {
+        return NS_ERROR_NOT_AVAILABLE;
+    }
+
     SocketContext sock;
     sock.mFD = fd;
     sock.mHandler = handler;

netwerk/base/src/nsSocketTransportService2.h

@@ -48,6 +48,7 @@
 #include "prinrval.h"
 #include "prlog.h"
 #include "prio.h"
+#include "nsASocketHandler.h"
 
 //-----------------------------------------------------------------------------
 
@@ -65,63 +66,6 @@ extern PRLogModuleInfo *gSocketTransportLog;
 #define NS_SOCKET_MAX_COUNT    50
 #define NS_SOCKET_POLL_TIMEOUT PR_INTERVAL_NO_TIMEOUT
 
-//-----------------------------------------------------------------------------
-// socket handler: methods are only called on the socket thread.
-
-class nsASocketHandler : public nsISupports
-{
-public:
-    nsASocketHandler()
-        : mCondition(NS_OK)
-        , mPollFlags(0)
-        , mPollTimeout(PR_UINT16_MAX)
-        {}
-
-    //
-    // this condition variable will be checked to determine if the socket
-    // handler should be detached.  it must only be accessed on the socket
-    // thread.
-    //
-    nsresult mCondition;
-
-    //
-    // these flags can only be modified on the socket transport thread.
-    // the socket transport service will check these flags before calling
-    // PR_Poll.
-    //
-    PRUint16 mPollFlags;
-
-    //
-    // this value specifies the maximum amount of time in seconds that may be
-    // spent waiting for activity on this socket.  if this timeout is reached,
-    // then OnSocketReady will be called with outFlags = -1.
-    //
-    // the default value for this member is PR_UINT16_MAX, which disables the
-    // timeout error checking.  (i.e., a timeout value of PR_UINT16_MAX is
-    // never reached.)
-    //
-    PRUint16 mPollTimeout;
-
-    //
-    // called to service a socket
-    // 
-    // params:
-    //   socketRef - socket identifier
-    //   fd        - socket file descriptor
-    //   outFlags  - value of PR_PollDesc::out_flags after PR_Poll returns
-    //               or -1 if a timeout occured
-    //
-    virtual void OnSocketReady(PRFileDesc *fd, PRInt16 outFlags) = 0;
-
-    //
-    // called when a socket is no longer under the control of the socket
-    // transport service.  the socket handler may close the socket at this
-    // point.  after this call returns, the handler will no longer be owned
-    // by the socket transport service.
-    //
-    virtual void OnSocketDetached(PRFileDesc *fd) = 0;
-};
-
 //-----------------------------------------------------------------------------
 
 class nsSocketTransportService : public nsPISocketTransportService
@@ -150,24 +94,6 @@ public:
         return mActiveCount + mIdleCount < NS_SOCKET_MAX_COUNT;
     }
 
-    //
-    // 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.
-    //
-    nsresult NotifyWhenCanAttachSocket(nsIRunnable *);
-
-    //
-    // add a new socket to the list of controlled sockets.  returns a socket
-    // reference for the newly attached socket that can be used with other
-    // methods to control the socket.
-    //
-    // NOTE: this function may only be called from an event dispatch on the
-    //       socket thread.
-    //
-    nsresult AttachSocket(PRFileDesc *fd, nsASocketHandler *);
-
 protected:
 
     virtual ~nsSocketTransportService();