From dfddf0909063766f8ac2e968b6a89e5d11e5d5d2 Mon Sep 17 00:00:00 2001 From: Nivedita Sarkar Date: Fri, 6 Sep 2024 15:04:21 -0700 Subject: [PATCH] Address review comments --- src/protocols/bdx/BdxTransferSession.h | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/src/protocols/bdx/BdxTransferSession.h b/src/protocols/bdx/BdxTransferSession.h index b8417b7749f2ce..99dcd5c9010609 100644 --- a/src/protocols/bdx/BdxTransferSession.h +++ b/src/protocols/bdx/BdxTransferSession.h @@ -168,17 +168,15 @@ class DLL_EXPORT TransferSession /** * @brief * Gets the pending output event from the transfer session in the event param passed in by the caller. - * The output event may contain some data for the caller to act upon. + * The output event may contain some data for the caller to act upon. If there is no pending output event, + * the caller will get an event of type - OutputEventType::kNone. * * It is possible that consecutive calls to this method may emit different outputs depending on the state of the - * TransferSession object and so we need to call this until we get an event of type - OutputEventType::kNone + * TransferSession object and the caller needs to call this until we get an event of type - OutputEventType::kNone * * If the output event type is kMsgToSend, the caller is expected to send the message immediately on the * relevant exchange. In this case the BDX session timeout timer will start when GetNextAction is called. * - * For all other event types, the caller is expected to pass the event to HandleTransferSessionOutput to handle the BDX - * message or any other TransferSession event. - * * See OutputEventType for all possible output event types. * * @param event Reference to an OutputEvent struct that will be filled out with any pending output event data