Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nivi-apple committed Sep 6, 2024
1 parent e6b2702 commit dfddf09
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/protocols/bdx/BdxTransferSession.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit dfddf09

Please sign in to comment.