Reintroduce (deprecated!) OPTION_C2D_KEEP_ALIVE_FREQ_SECS to undo a b…

…reaking change
Azure · Feb 9, 2018 · 2222de6 · 2222de6
1 parent b4e1dc0
commit 2222de6
Showing 1 changed file with 10 additions and 7 deletions.
diff --git a/iothub_client/inc/iothub_client_options.h b/iothub_client/inc/iothub_client_options.h
@@ -44,13 +44,16 @@ extern "C"
     */
     static const char* OPTION_SERVICE_SIDE_KEEP_ALIVE_FREQ_SECS = "svc2cl_keep_alive_timeout_secs";
 
-	/*
-	* @brief Ratio to be used for client side pings in AMQP protocol.
-	*        The client must use this ratio to send keep-alives before service side remote idle timeout is reached, otherwise the service will disconnect the client.
-	*        The default value for this option is 1/2 of the remote idle value sent by the service. 
-	*        For AMQP remote idle set to 4 minutes, default client ping will be 2 minutes. For AMQP remote idle set to 25 minutes configured via per Hub basis, the default ping will be 12.5 minutes.
-	*/
-	static const char* OPTION_REMOTE_IDLE_TIMEOUT_RATIO = "cl2svc_keep_alive_send_ratio"; 
+    /* DEPRECATED:: OPTION_C2D_KEEP_ALIVE_FREQ_SECS is DEPRECATED!  Use OPTION_SERVICE_SIDE_KEEP_ALIVE_FREQ_SECS, but OPTION_C2D_KEEP_ALIVE_FREQ_SECS legacy variable kept for back-compat.  */ 
+    static const char* OPTION_C2D_KEEP_ALIVE_FREQ_SECS = "svc2cl_keep_alive_timeout_secs"; 
+
+    /*
+    * @brief Ratio to be used for client side pings in AMQP protocol.
+    *        The client must use this ratio to send keep-alives before service side remote idle timeout is reached, otherwise the service will disconnect the client.
+    *        The default value for this option is 1/2 of the remote idle value sent by the service. 
+    *        For AMQP remote idle set to 4 minutes, default client ping will be 2 minutes. For AMQP remote idle set to 25 minutes configured via per Hub basis, the default ping will be 12.5 minutes.
+    */
+    static const char* OPTION_REMOTE_IDLE_TIMEOUT_RATIO = "cl2svc_keep_alive_send_ratio"; 
 
     //diagnostic sampling percentage value, [0-100]
     static const char* OPTION_DIAGNOSTIC_SAMPLING_PERCENTAGE = "diag_sampling_percentage";