Announce ntci::StreamSocketSession connection initiate and complete events

mattrm456 · web-flow · commit 231e8ebfc6aa · 2025-05-02T08:37:37.000-04:00
diff --git a/groups/ntc/ntca/ntca_connectevent.h b/groups/ntc/ntca/ntca_connectevent.h
@@ -59,7 +59,7 @@ class ConnectEvent
     /// Create a new connect event having the same value as the specified
     /// 'original' object. Optionally specify a 'basicAllocator'
     /// used to supply memory. If 'basicAllocator' is 0, the currently
-    /// installed default allocator is used.s
+    /// installed default allocator is used.
     ConnectEvent(const ConnectEvent& original,
                  bslma::Allocator*   basicAllocator = 0);
 
@@ -87,16 +87,20 @@ class ConnectEvent
     /// Return the state of the connect attempt at the time of the event.
     const ntca::ConnectContext& context() const;
 
-    /// Return true if 'type() == ntca::ConnectEventType::e_COMPLETE', i.e.,
-    /// the connect operation successfully completed without an error.
-    /// Otherwise, return false.
-    bool isComplete() const;
+    /// Return true if 'type() == ntca::ConnectEventType::e_INITIATED', i.e.,
+    /// the connect operation has been initiated. Otherwise, return false.
+    bool isInitiated() const;
 
     /// Return true if 'type() == ntca::ConnectEventType::e_ERROR', i.e.,
     /// the connect operation failed because of an error. Otherwise, return
     /// false. Note that the exact error is stored at 'context().error()'.
     bool isError() const;
 
+    /// Return true if 'type() == ntca::ConnectEventType::e_COMPLETE', i.e.,
+    /// the connect operation successfully completed without an error.
+    /// Otherwise, return false.
+    bool isComplete() const;
+
     /// Return true if this object has the same value as the specified
     /// 'other' object, otherwise return false.
     bool equals(const ConnectEvent& other) const;
@@ -216,9 +220,9 @@ const ntca::ConnectContext& ConnectEvent::context() const
 }
 
 NTCCFG_INLINE
-bool ConnectEvent::isComplete() const
+bool ConnectEvent::isInitiated() const
 {
-    return d_type == ntca::ConnectEventType::e_COMPLETE;
+    return d_type == ntca::ConnectEventType::e_INITIATED;
 }
 
 NTCCFG_INLINE
@@ -227,6 +231,12 @@ bool ConnectEvent::isError() const
     return d_type == ntca::ConnectEventType::e_ERROR;
 }
 
+NTCCFG_INLINE
+bool ConnectEvent::isComplete() const
+{
+    return d_type == ntca::ConnectEventType::e_COMPLETE;
+}
+
 NTCCFG_INLINE
 bsl::ostream& operator<<(bsl::ostream& stream, const ConnectEvent& object)
 {
diff --git a/groups/ntc/ntca/ntca_connecteventtype.cpp b/groups/ntc/ntca/ntca_connecteventtype.cpp
@@ -28,8 +28,9 @@ namespace ntca {
 int ConnectEventType::fromInt(ConnectEventType::Value* result, int number)
 {
     switch (number) {
-    case ConnectEventType::e_COMPLETE:
+    case ConnectEventType::e_INITIATED:
     case ConnectEventType::e_ERROR:
+    case ConnectEventType::e_COMPLETE:
         *result = static_cast<ConnectEventType::Value>(number);
         return 0;
     default:
@@ -40,27 +41,36 @@ int ConnectEventType::fromInt(ConnectEventType::Value* result, int number)
 int ConnectEventType::fromString(ConnectEventType::Value* result,
                                  const bslstl::StringRef& string)
 {
-    if (bdlb::String::areEqualCaseless(string, "COMPLETE")) {
-        *result = e_COMPLETE;
+    if (bdlb::String::areEqualCaseless(string, "INITIATED")) {
+        *result = e_INITIATED;
         return 0;
     }
+
     if (bdlb::String::areEqualCaseless(string, "ERROR")) {
         *result = e_ERROR;
         return 0;
     }
 
+    if (bdlb::String::areEqualCaseless(string, "COMPLETE")) {
+        *result = e_COMPLETE;
+        return 0;
+    }
+
     return -1;
 }
 
 const char* ConnectEventType::toString(ConnectEventType::Value value)
 {
     switch (value) {
-    case e_COMPLETE: {
-        return "COMPLETE";
+    case e_INITIATED: {
+        return "INITIATED";
     } break;
     case e_ERROR: {
         return "ERROR";
     } break;
+    case e_COMPLETE: {
+        return "COMPLETE";
+    } break;
     }
 
     BSLS_ASSERT(!"invalid enumerator");
diff --git a/groups/ntc/ntca/ntca_connecteventtype.h b/groups/ntc/ntca/ntca_connecteventtype.h
@@ -35,11 +35,14 @@ struct ConnectEventType {
   public:
     /// Enumerate the connect event types.
     enum Value {
-        // The connection sequence is complete.
-        e_COMPLETE = 0,
+        /// The connection sequence has been initiated.
+        e_INITIATED = 0,
 
         // An error has been detected during the connection sequence.
-        e_ERROR = 1
+        e_ERROR = 1,
+
+        // The connection sequence is complete.
+        e_COMPLETE = 2
     };
 
     /// Return the string representation exactly matching the enumerator
diff --git a/groups/ntc/ntca/ntca_upgradeeventtype.cpp b/groups/ntc/ntca/ntca_upgradeeventtype.cpp
@@ -28,8 +28,9 @@ namespace ntca {
 int UpgradeEventType::fromInt(UpgradeEventType::Value* result, int number)
 {
     switch (number) {
-    case UpgradeEventType::e_COMPLETE:
+    case UpgradeEventType::e_INITIATED:
     case UpgradeEventType::e_ERROR:
+    case UpgradeEventType::e_COMPLETE:
         *result = static_cast<UpgradeEventType::Value>(number);
         return 0;
     default:
@@ -40,27 +41,36 @@ int UpgradeEventType::fromInt(UpgradeEventType::Value* result, int number)
 int UpgradeEventType::fromString(UpgradeEventType::Value* result,
                                  const bslstl::StringRef& string)
 {
-    if (bdlb::String::areEqualCaseless(string, "COMPLETE")) {
-        *result = e_COMPLETE;
+    if (bdlb::String::areEqualCaseless(string, "INITIATED")) {
+        *result = e_INITIATED;
         return 0;
     }
+
     if (bdlb::String::areEqualCaseless(string, "ERROR")) {
         *result = e_ERROR;
         return 0;
     }
 
+    if (bdlb::String::areEqualCaseless(string, "COMPLETE")) {
+        *result = e_COMPLETE;
+        return 0;
+    }
+
     return -1;
 }
 
 const char* UpgradeEventType::toString(UpgradeEventType::Value value)
 {
     switch (value) {
-    case e_COMPLETE: {
-        return "COMPLETE";
+    case e_INITIATED: {
+        return "INITIATED";
     } break;
     case e_ERROR: {
         return "ERROR";
     } break;
+    case e_COMPLETE: {
+        return "COMPLETE";
+    } break;
     }
 
     BSLS_ASSERT(!"invalid enumerator");
diff --git a/groups/ntc/ntca/ntca_upgradeeventtype.h b/groups/ntc/ntca/ntca_upgradeeventtype.h
@@ -35,11 +35,14 @@ struct UpgradeEventType {
   public:
     /// Enumerate the upgrade event types.
     enum Value {
-        /// The upgrade sequence is complete.
-        e_COMPLETE = 0,
+        /// The upgrade sequence has been initiated.
+        e_INITIATED = 0,
 
         /// An error has been detected during the upgrade sequence.
-        e_ERROR = 1
+        e_ERROR = 1,
+
+        /// The upgrade sequence is complete.
+        e_COMPLETE = 2
     };
 
     /// Return the string representation exactly matching the enumerator
diff --git a/groups/ntc/ntci/ntci_streamsocketsession.cpp b/groups/ntc/ntci/ntci_streamsocketsession.cpp
@@ -27,6 +27,22 @@ StreamSocketSession::~StreamSocketSession()
 {
 }
 
+void StreamSocketSession::processConnectInitiated(
+    const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+    const ntca::ConnectEvent&                  event)
+{
+    NTCCFG_WARNING_UNUSED(streamSocket);
+    NTCCFG_WARNING_UNUSED(event);
+}
+
+void StreamSocketSession::processConnectComplete(
+    const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+    const ntca::ConnectEvent&                  event)
+{
+    NTCCFG_WARNING_UNUSED(streamSocket);
+    NTCCFG_WARNING_UNUSED(event);
+}
+
 void StreamSocketSession::processReadQueueFlowControlRelaxed(
     const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
     const ntca::ReadQueueEvent&                event)
@@ -147,6 +163,23 @@ void StreamSocketSession::processDowngradeInitiated(
     NTCCFG_WARNING_UNUSED(event);
 }
 
+
+void StreamSocketSession::processDowngradeReceive(
+        const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+        const ntca::DowngradeEvent&                event)
+{
+    NTCCFG_WARNING_UNUSED(streamSocket);
+    NTCCFG_WARNING_UNUSED(event);
+}
+
+void StreamSocketSession::processDowngradeSend(
+        const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+        const ntca::DowngradeEvent&                event)
+{
+    NTCCFG_WARNING_UNUSED(streamSocket);
+    NTCCFG_WARNING_UNUSED(event);
+}
+
 void StreamSocketSession::processDowngradeComplete(
     const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
     const ntca::DowngradeEvent&                event)
diff --git a/groups/ntc/ntci/ntci_streamsocketsession.h b/groups/ntc/ntci/ntci_streamsocketsession.h
@@ -57,6 +57,16 @@ class StreamSocketSession
     /// Destroy this object.
     virtual ~StreamSocketSession();
 
+    /// Process the condition that a connection is initiated.
+    virtual void processConnectInitiated(
+        const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+        const ntca::ConnectEvent&                  event);
+
+    /// Process the condition that a connection is complete.
+    virtual void processConnectComplete(
+        const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+        const ntca::ConnectEvent&                  event);
+
     /// Process the condition that read queue flow control has been relaxed:
     /// the socket receive buffer is being automatically copied to the read
     /// queue.
@@ -158,6 +168,17 @@ class StreamSocketSession
         const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
         const ntca::DowngradeEvent&                event);
 
+    /// Process the socket being shut down for reading encryption 
+    /// communication.
+    virtual void processDowngradeReceive(
+        const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+        const ntca::DowngradeEvent&                event);
+
+    /// Process the socket being shut down for writing encrypted communication.
+    virtual void processDowngradeSend(
+        const bsl::shared_ptr<ntci::StreamSocket>& streamSocket,
+        const ntca::DowngradeEvent&                event);
+
     /// Process the completion of a downgrade from encrypted to unencrypted
     /// communication.
     virtual void processDowngradeComplete(
diff --git a/groups/ntc/ntcp/ntcp_streamsocket.cpp b/groups/ntc/ntcp/ntcp_streamsocket.cpp
@@ -839,17 +839,33 @@ void StreamSocket::privateCompleteConnect(
 
     NTCI_LOG_TRACE("Connection attempt succeeded");
 
+    if (d_session_sp) {
+        ntcs::Dispatch::announceConnectComplete(
+            d_session_sp,
+            self,
+            connectEvent,
+            d_sessionStrand_sp,
+            ntci::Strand::unknown(),
+            self,
+            false,
+            &d_mutex);
+
+        if (d_openState.value() != ntcs::OpenState::e_CONNECTED) {
+            return;
+        }
+    }
+
     if (connectCallback) {
         connectCallback.dispatch(self,
                                  connectEvent,
                                  d_proactorStrand_sp,
                                  self,
                                  false,
                                  &d_mutex);
-    }
 
-    if (d_openState.value() != ntcs::OpenState::e_CONNECTED) {
-        return;
+        if (d_openState.value() != ntcs::OpenState::e_CONNECTED) {
+            return;
+        }
     }
 
     ntcs::Dispatch::announceEstablished(d_manager_sp,
@@ -1031,6 +1047,18 @@ void StreamSocket::privateFailConnectComplete(
         }
     }
 
+    if (d_session_sp) {
+        ntcs::Dispatch::announceConnectComplete(
+            d_session_sp,
+            self,
+            connectEvent,
+            d_sessionStrand_sp,
+            ntci::Strand::unknown(),
+            self,
+            defer,
+            &d_mutex);
+    }
+
     if (connectCallback) {
         connectCallback.dispatch(self,
                                  connectEvent,
@@ -3348,6 +3376,25 @@ void StreamSocket::processRemoteEndpointResolution(
         d_publicSourceEndpoint = d_systemSourceEndpoint;
     }
 
+    if (!error) {
+        d_systemRemoteEndpoint = endpoint;
+        d_publicRemoteEndpoint = endpoint;
+
+        ntca::ConnectEvent event;
+        event.setType(ntca::ConnectEventType::e_INITIATED);
+        event.setContext(d_connectContext);
+
+        ntcs::Dispatch::announceConnectInitiated(
+            d_session_sp,
+            self,
+            event,
+            d_sessionStrand_sp,
+            ntci::Strand::unknown(),
+            self,
+            false,
+            &d_mutex);
+    }
+
     if (error) {
         this->privateFailConnect(self, error, false, false);
     }
@@ -3607,6 +3654,25 @@ ntsa::Error StreamSocket::privateRetryConnectToEndpoint(
 
     d_publicSourceEndpoint = d_systemSourceEndpoint;
 
+    d_systemRemoteEndpoint = d_connectEndpoint;
+    d_publicRemoteEndpoint = d_connectEndpoint;
+
+    if (d_session_sp) {
+        ntca::ConnectEvent event;
+        event.setType(ntca::ConnectEventType::e_INITIATED);
+        event.setContext(d_connectContext);
+
+        ntcs::Dispatch::announceConnectInitiated(
+            d_session_sp,
+            self,
+            event,
+            d_sessionStrand_sp,
+            ntci::Strand::unknown(),
+            self,
+            false,
+            &d_mutex);
+    }
+
     return ntsa::Error();
 }
 
diff --git a/groups/ntc/ntcr/ntcr_streamsocket.cpp b/groups/ntc/ntcr/ntcr_streamsocket.cpp
diff --git a/groups/ntc/ntcs/ntcs_dispatch.cpp b/groups/ntc/ntcs/ntcs_dispatch.cpp
diff --git a/groups/ntc/ntcs/ntcs_dispatch.h b/groups/ntc/ntcs/ntcs_dispatch.h
