Rename two functions, shorten timeout during test, and fix comment typo

Author: cpsughrue

llvm/include/llvm/Support/raw_socket_stream.h

@@ -64,8 +64,8 @@ class ListeningSocket {
 
   /// If a seperate thread calls ListeningSocket::shutdown, the ListeningSocket
   /// file descriptor (FD) could be closed while ::poll is waiting for it to be
-  /// ready to performa I/O operations. ::poll with continue to block even after
-  /// FD is closed so use a self-pipe mechanism to get ::poll to return
+  /// ready to perform a I/O operations. ::poll with continue to block even
+  /// after FD is closed so use a self-pipe mechanism to get ::poll to return
   int PipeFD[2]; // Never modified after construction
 
   ListeningSocket(int SocketFD, StringRef SocketPath, int PipeFD[2]);
@@ -107,7 +107,7 @@ class ListeningSocket {
   /// \param SocketPath The file system path where the socket will be created
   /// \param MaxBacklog The max number of connections in a socket's backlog
   ///
-  static Expected<ListeningSocket> createListeningUnixSocket(
+  static Expected<ListeningSocket> createUnix(
       StringRef SocketPath,
       int MaxBacklog = llvm::hardware_concurrency().compute_thread_count());
 };
@@ -127,7 +127,7 @@ class raw_socket_stream : public raw_fd_stream {
   /// Create a \p raw_socket_stream connected to the UNIX domain socket at \p
   /// SocketPath.
   static Expected<std::unique_ptr<raw_socket_stream>>
-  createConnectedUnixSocket(StringRef SocketPath);
+  createConnectedUnix(StringRef SocketPath);
   ~raw_socket_stream();
 };
 

llvm/lib/Support/raw_socket_stream.cpp

@@ -107,9 +107,8 @@ ListeningSocket::ListeningSocket(ListeningSocket &&LS)
   LS.PipeFD[1] = -1;
 }
 
-Expected<ListeningSocket>
-ListeningSocket::createListeningUnixSocket(StringRef SocketPath,
-                                           int MaxBacklog) {
+Expected<ListeningSocket> ListeningSocket::createUnix(StringRef SocketPath,
+                                                      int MaxBacklog) {
 
   // Handle instances where the target socket address already exists and
   // differentiate between a preexisting file with and without a bound socket
@@ -262,7 +261,7 @@ raw_socket_stream::raw_socket_stream(int SocketFD)
     : raw_fd_stream(SocketFD, true) {}
 
 Expected<std::unique_ptr<raw_socket_stream>>
-raw_socket_stream::createConnectedUnixSocket(StringRef SocketPath) {
+raw_socket_stream::createConnectedUnix(StringRef SocketPath) {
 #ifdef _WIN32
   WSABalancer _;
 #endif // _WIN32

llvm/unittests/Support/raw_socket_stream_test.cpp

@@ -39,13 +39,13 @@ TEST(raw_socket_streamTest, CLIENT_TO_SERVER_AND_SERVER_TO_CLIENT) {
   std::remove(SocketPath.c_str());
 
   Expected<ListeningSocket> MaybeServerListener =
-      ListeningSocket::createListeningUnixSocket(SocketPath);
+      ListeningSocket::createUnix(SocketPath);
   ASSERT_THAT_EXPECTED(MaybeServerListener, llvm::Succeeded());
 
   ListeningSocket ServerListener = std::move(*MaybeServerListener);
 
   Expected<std::unique_ptr<raw_socket_stream>> MaybeClient =
-      raw_socket_stream::createConnectedUnixSocket(SocketPath);
+      raw_socket_stream::createConnectedUnix(SocketPath);
   ASSERT_THAT_EXPECTED(MaybeClient, llvm::Succeeded());
 
   raw_socket_stream &Client = **MaybeClient;
@@ -79,17 +79,18 @@ TEST(raw_socket_streamTest, TIMEOUT_PROVIDED) {
   std::remove(SocketPath.c_str());
 
   Expected<ListeningSocket> MaybeServerListener =
-      ListeningSocket::createListeningUnixSocket(SocketPath);
+      ListeningSocket::createUnix(SocketPath);
   ASSERT_THAT_EXPECTED(MaybeServerListener, llvm::Succeeded());
   ListeningSocket ServerListener = std::move(*MaybeServerListener);
 
-  std::chrono::seconds Timeout = std::chrono::seconds(5);
+  std::chrono::milliseconds Timeout = std::chrono::milliseconds(100);
   auto Start = std::chrono::steady_clock::now();
   Expected<std::unique_ptr<raw_socket_stream>> MaybeServer =
       ServerListener.accept(Timeout);
   auto End = std::chrono::steady_clock::now();
-  auto Duration = std::chrono::duration_cast<std::chrono::seconds>(End - Start);
-  ASSERT_NEAR(Duration.count(), Timeout.count(), 1);
+  auto Duration =
+      std::chrono::duration_cast<std::chrono::milliseconds>(End - Start);
+  ASSERT_NEAR(Duration.count(), Timeout.count(), 10);
 
   ASSERT_THAT_EXPECTED(MaybeServer, Failed());
   llvm::Error Err = MaybeServer.takeError();
@@ -110,7 +111,7 @@ TEST(raw_socket_streamTest, FILE_DESCRIPTOR_CLOSED) {
   std::remove(SocketPath.c_str());
 
   Expected<ListeningSocket> MaybeServerListener =
-      ListeningSocket::createListeningUnixSocket(SocketPath);
+      ListeningSocket::createUnix(SocketPath);
   ASSERT_THAT_EXPECTED(MaybeServerListener, llvm::Succeeded());
   ListeningSocket ServerListener = std::move(*MaybeServerListener);