Home | History | Annotate | Download | only in base
      1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef NET_BASE_WINSOCK_UTIL_H_
      6 #define NET_BASE_WINSOCK_UTIL_H_
      7 
      8 #include <winsock2.h>
      9 
     10 #include "net/base/net_export.h"
     11 
     12 namespace net {
     13 
     14 // Assert that the (manual-reset) event object is not signaled.
     15 void AssertEventNotSignaled(WSAEVENT hEvent);
     16 
     17 // If the (manual-reset) event object is signaled, resets it and returns true.
     18 // Otherwise, does nothing and returns false.  Called after a Winsock function
     19 // succeeds synchronously
     20 //
     21 // Our testing shows that except in rare cases (when running inside QEMU),
     22 // the event object is already signaled at this point, so we call this method
     23 // to avoid a context switch in common cases.  This is just a performance
     24 // optimization.  The code still works if this function simply returns false.
     25 bool ResetEventIfSignaled(WSAEVENT hEvent);
     26 
     27 // Interface to create Windows Socket.
     28 // Usually such factories are used for testing purposes, which is not true in
     29 // this case. This interface is used to substitute WSASocket to make possible
     30 // execution of some network code in sandbox.
     31 class NET_EXPORT PlatformSocketFactory {
     32  public:
     33   PlatformSocketFactory() {}
     34   virtual ~PlatformSocketFactory() {}
     35 
     36   // Creates Windows socket. See WSASocket documentation of parameters.
     37   virtual SOCKET CreateSocket(int family, int type, int protocol) = 0;
     38 
     39   // Replace WSASocket with given factory. The factory will be used by
     40   // CreatePlatformSocket.
     41   static void SetInstance(PlatformSocketFactory* factory);
     42 };
     43 
     44 // Creates Windows Socket. See WSASocket documentation of parameters.
     45 SOCKET CreatePlatformSocket(int family, int type, int protocol);
     46 
     47 }  // namespace net
     48 
     49 #endif  // NET_BASE_WINSOCK_UTIL_H_
     50