Add doc that keep-alive is unsupported with dummy timer #132
Conversation
| @@ -100,6 +100,12 @@ | |||
| * If a ping response is not received before this timeout, then | |||
| * #MQTT_ProcessLoop will return #MQTTKeepAliveTimeout. | |||
| * | |||
| * @note If a dummy implementation of the #MQTTGetCurrentTimeFunc_t timer function, | |||
There was a problem hiding this comment.
- Let's just say that if a dummy implementation of the timer function is used. I don't we need to go into details of 'that always returns zero'. Let's keep it simple.
- processLoop is not supported without a 'real' time function. In that case receiveLoop should be used. ( receive loop is exactly processLopp mius keep alive.
There was a problem hiding this comment.
Have incorporated point 1. The second point is not appropriate for this config that is only utilized by ProcessLoop.
| @@ -598,21 +598,23 @@ MQTTStatus_t MQTT_Disconnect( MQTTContext_t * pContext ); | |||
| * alive. | |||
| * | |||
| * @note Passing a timeout value of 0 will run the loop for a single iteration. | |||
| * If a dummy #MQTTGetCurrentTimeFunc_t was passed to #MQTT_Init, then the timeout | |||
There was a problem hiding this comment.
We should just say that it is not supported with dummy timer function and reference doxygen for timer function ( to explain what we mean by dummy)
There was a problem hiding this comment.
The presence of #MQTTGetCurrentTimeFunc_t adds the reference to the documentation of the timer function
There was a problem hiding this comment.
We should just say that it is not supported with dummy timer function
Only the keep-alive part of the function is not supported with a dummy timer function. The rest of the functionality of receiving acks and incoming PUBLISH is supported
https://github.com/aggarw13/coreMQTT into doc/mention-no-support-of-keep-alive-with-dummy-timer
aggarw13
deleted the
doc/mention-no-support-of-keep-alive-with-dummy-timer
branch
Update API doc to mention that the keep-alive mechanism is not supported by
MQTT_ProcessLoopAPI when a dummy timer function that always returns zero is supplied to the library.