Skip to content

Commit 56ff8fc

Browse files
committed
Added comments
1 parent 0cf1672 commit 56ff8fc

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/app/icd/client/CheckInDelegate.h

+7-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ namespace chip {
2424
namespace app {
2525

2626
/// Callbacks for check in protocol
27+
/**
28+
* @brief The application implementing an ICD client should inherit the CheckInDelegate and implement the listed callbacks
29+
* OnCheckInComplete will be called on successful processing of a received checkIn message from the server
30+
* OnRefreshKey will be called when the key needs to be refreshed to avoid check in counter roll over problems. On receiving
31+
* OnRefreshKey callback, the application should generate a new key.
32+
*/
2733
class DLL_EXPORT CheckInDelegate
2834
{
2935
public:
@@ -40,7 +46,7 @@ class DLL_EXPORT CheckInDelegate
4046
* @brief Callback used to let the application know that a checkin message was received and validated and a key refresh is
4147
* needed to avoid counter roolover problems.
4248
*
43-
* The implementor of this function should generate a new key
49+
* The implementer of this function should generate a new key
4450
*
4551
* @param[out] keyData - new key generated
4652
*/

0 commit comments

Comments
 (0)