make connection async close wait opt-in

Author: mtfriesen

src/core/api.c

@@ -217,6 +217,7 @@ MsQuicConnectionClose(
         if (MsQuicLib.CustomExecutions) {
             //
             // For custom executions, ConnectionClose completes asynchronously.
+            // Review: should this be opt-in behavior?
             //
             Connection->CloseApiContext.Completed = NULL;
             WaitForCompletion = FALSE;

src/inc/msquic.hpp

@@ -1149,7 +1149,7 @@ struct MsQuicConnection {
     QUIC_UINT62 AppShutdownErrorCode {0};
     bool HandshakeComplete {false};
     bool HandshakeResumed {false};
-    bool Started {false};
+    bool AsyncClose {false};
     uint32_t ResumptionTicketLength {0};
     uint8_t* ResumptionTicket {nullptr};
 #ifdef CX_PLATFORM_TYPE
@@ -1217,7 +1217,7 @@ struct MsQuicConnection {
     ~MsQuicConnection() noexcept {
         Close();
 #ifdef CX_PLATFORM_TYPE
-        if (IsValid()) {
+        if (AsyncClose) {
             ShutdownCompleteEvent.WaitForever();
         }
 #endif // CX_PLATFORM_TYPE
@@ -1263,11 +1263,7 @@ struct MsQuicConnection {
             const char* ServerName,
         _In_ uint16_t ServerPort // Host byte order
         ) noexcept {
-        QUIC_STATUS Status = MsQuic->ConnectionStart(Handle, Config, Family, ServerName, ServerPort);
-        if (QUIC_SUCCEEDED(Status)) {
-            Started = true;
-        }
-        return Status;
+        return MsQuic->ConnectionStart(Handle, Config, Family, ServerName, ServerPort);
     }
 
     QUIC_STATUS

src/test/lib/ApiTest.cpp

@@ -6989,7 +6989,9 @@ QuicTestValidatePartitionInline(const uint32_t EcCount)
     // The registration close will not complete until each of these objects is
     // cleaned up, so we do not need to wait for each of these explicitly.
     //
+    Server->AsyncClose = TRUE;
     Server->Close();
+    Server->AsyncClose = TRUE;
     Client->Close();
     Listener.Stop();
 
@@ -7124,6 +7126,13 @@ QuicTestValidatePartitionWorker(const uint32_t EcCount)
                 return QUIC_STATUS_CONTINUE;
             })
         );
+
+        //
+        // Ensure the connections wait for the final shutdown callback before
+        // finishing destruction.
+        //
+        Server->AsyncClose = TRUE;
+        Client.AsyncClose = TRUE;
     }
 
     for (uint32_t i = 0; i < EcCount; i++) {