Skip to content

Commit 3c0ca7c

Browse files
Apply suggestions from code review
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
1 parent d344a19 commit 3c0ca7c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/protocols/bdx/AsyncTransferFacilitator.h

+6-6
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ namespace chip {
2727
namespace bdx {
2828

2929
/**
30-
* An abstract class with methods for handling BDX messages received from an ExchangeContext. Once a message is receievd, this
31-
* class passes the message to the TransferSession to process the received message and gets the next output events from the
30+
* An abstract class with methods for handling BDX messages received from an ExchangeContext. Once a message is received, this
31+
* class passes the message to the TransferSession to process the received message and gets the resulting output events from the
3232
* TransferSession state machine and either sends a message accross the exchange or calls the HandleTransferSessionOutput virtual
33-
* method to notify the subclass of the event generated. It keeps getting the next output event until it receieves an output event
34-
* of type TransferSession::OutputEventType::kNone. For messages that are sent to the HandleTransferSessionOutput method, the
33+
* method to notify the subclass of the event generated. It keeps getting the next output event until it recieves an output event
34+
* of type TransferSession::OutputEventType::kNone. For events that are handled via the HandleTransferSessionOutput method, the
3535
* subclass must call the NotifyEventHandled to notify the AsyncTransferFacilitator that the event has been handled and returns an
3636
* error code for error cases or success.
3737
*
@@ -115,13 +115,13 @@ class AsyncResponder : public AsyncTransferFacilitator
115115

116116
/**
117117
* This is called by the subclass implementing HandleTransferSessionOutput to notify the AsyncTransferFacilitator
118-
* that it has handled the OutputEvent specified in event and returns an error code (if any) or success in the error paramter.
118+
* that it has handled the OutputEvent specified in "event" and "status" is the result of handling the event.
119119
* Once this is called the AsyncTransferFacilitator either aborts the transfer if an error has ocurred or drives the
120120
* TransferSession state machine to generate the next output events to establish and continue the BDX session further.
121121
*
122122
*
123123
* @param[in] event The OutputEvent that was handled by the subclass.
124-
* @param[in] error The error code that occured when handling the event if an error occurs. Otherwise has CHIP_NO_ERROR.
124+
* @param[in] status The error code that occured when handling the event if an error occurs. Otherwise CHIP_NO_ERROR.
125125
*/
126126
void NotifyEventHandled(TransferSession::OutputEvent & event, CHIP_ERROR error);
127127
};

0 commit comments

Comments
 (0)