Skip to content

Commit dfddf09

Browse files
committed
Address review comments
1 parent e6b2702 commit dfddf09

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

src/protocols/bdx/BdxTransferSession.h

+3-5
Original file line numberDiff line numberDiff line change
@@ -168,17 +168,15 @@ class DLL_EXPORT TransferSession
168168
/**
169169
* @brief
170170
* Gets the pending output event from the transfer session in the event param passed in by the caller.
171-
* The output event may contain some data for the caller to act upon.
171+
* The output event may contain some data for the caller to act upon. If there is no pending output event,
172+
* the caller will get an event of type - OutputEventType::kNone.
172173
*
173174
* It is possible that consecutive calls to this method may emit different outputs depending on the state of the
174-
* TransferSession object and so we need to call this until we get an event of type - OutputEventType::kNone
175+
* TransferSession object and the caller needs to call this until we get an event of type - OutputEventType::kNone
175176
*
176177
* If the output event type is kMsgToSend, the caller is expected to send the message immediately on the
177178
* relevant exchange. In this case the BDX session timeout timer will start when GetNextAction is called.
178179
*
179-
* For all other event types, the caller is expected to pass the event to HandleTransferSessionOutput to handle the BDX
180-
* message or any other TransferSession event.
181-
*
182180
* See OutputEventType for all possible output event types.
183181
*
184182
* @param event Reference to an OutputEvent struct that will be filled out with any pending output event data

0 commit comments

Comments
 (0)