Update examples comments for AsyncResult.

examples/App/AppInitialization/CustomAuth/CustomAuth.ino

@@ -129,6 +129,33 @@
  *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
  *
+ * 
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ * 
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ * 
+ * There are two sources of async result in this library:
+ * 
+ * 1. From user provided with async application (function).
+ * 
+ * For example:
+ * 
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ * 
+ * 2. From dynamic allocation in the async client.
+ * 
+ * For example:
+ * 
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ * 
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ * 
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ * 
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ * 
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>

examples/App/AppInitialization/NoAuth/NoAuth.ino

@@ -107,6 +107,32 @@
  *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
  *
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>

examples/App/AppInitialization/SaveAndLoad/SaveAndLoad.ino

@@ -59,6 +59,33 @@
  *
  * Deallocation of FirebaseApp causes these services apps uninitialized and cannot be used.
  *
+ * 
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>
@@ -76,7 +103,7 @@
 
 #include <FirebaseClient.h>
 
-#if defined(ENABLE_FS) // Defined in this library
+#if defined(ENABLE_FS)  // Defined in this library
 #if defined(FLASH_SUPPORTS) // Defined in this library
 #if defined(ESP32)
 #include <SPIFFS.h>

examples/App/AppInitialization/ServiceAuth/ServiceAuth.ino

@@ -63,7 +63,7 @@
  *
  * For ServiceAuth and CustomAuth authentications, you need to check for JWT token geration process requirement,
  * before running the JWT process function in the main loop as the following.
- * 
+ *
  * JWT.loop(app.getAuth());
  *
  * SYNTAX:
@@ -124,6 +124,33 @@
  *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
  *
+ *
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>
@@ -141,7 +168,7 @@
 
 #include <FirebaseClient.h>
 
-#if defined(ENABLE_FS) // Defined in this library
+#if defined(ENABLE_FS)  // Defined in this library
 #if defined(FLASH_SUPPORTS) // Defined in this library
 #if defined(ESP32)
 #include <SPIFFS.h>

examples/App/AppInitialization/TokenAuth/AccessToken/AccessToken.ino

@@ -114,6 +114,33 @@
  *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
  *
+ *
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 #include <Arduino.h>
 #if defined(ESP32) || defined(ARDUINO_RASPBERRY_PI_PICO_W)

examples/App/AppInitialization/TokenAuth/CustomToken/CustomToken.ino

@@ -75,42 +75,69 @@
  * the async SSE (HTTP Streaming) slot.
  *
  * When the async operation queue is full, the new sync and async operations will be cancelled.
- * 
+ *
  * The finished and time out operating slot will be removed from the queue unless the async SSE and allow the vacant slot for the new async operation.
- * 
- * The async SSE operation will run continuously and repeatedly as long as the FirebaseApp and the services app 
+ *
+ * The async SSE operation will run continuously and repeatedly as long as the FirebaseApp and the services app
  * (Database, Firestore, Messaging, Functions, Storage and CloudStorage) objects was run in the loop via app.loop() or database.loop().
- * 
+ *
  * STOP QUEUE
  * ===========
- * 
+ *
  * SYNTAX:
- * 
+ *
  * The async operation will be cancelled and remove from the queue by calling thes functions.
- * 
+ *
  * asyncClient.stopAsync() - stop the last async operation in the queue.
- * 
+ *
  * asyncClient.stopAsync(true) - stop all async operation in the queue.
- * 
+ *
  * asyncClient.stopAsync("xxxx") - stop the async operation in the queue that has the async result UID xxxx.
- * 
+ *
  * ASYNC CLIENT
  * ============
- * 
+ *
  * The async client stores the async operating data in its queue and holds the pointer of SSL Client that assigned with it.
- * 
+ *
  * The SSL Client should be existed in the AsyncClient usage scope in case of sync or should defined as global object for async usage.
- * 
+ *
  * The SSL Client should not be shared among various AsyncClients because of interferences in async operations.
  *
  * Only one SSL Client should be assigned to or used with only one AsyncClient.
- * 
+ *
  * SSL Client can force to stop by user or calling stop() from asyncClient.
- * 
+ *
  * SYNTAX:
- * 
+ *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
- * 
+ *
+ *
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>

examples/App/AppInitialization/TokenAuth/IDToken/IDToken.ino

@@ -112,6 +112,33 @@
  *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
  *
+ *
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>

examples/App/AppInitialization/TokenAuth/LegacyToken/LegacyToken.ino

@@ -107,6 +107,33 @@
  *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
  *
+ *
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>

examples/App/AppInitialization/UserAuth/UserAuth.ino

@@ -111,6 +111,33 @@
  *
  * asyncClient.stop() - stop the SSL Client to terminate the server connection.
  *
+ *
+ * THE STATIC ASYNC RESULT REQUIRED FOR ASYNC OPERATION
+ * ====================================================
+ *
+ * Library provided the class object called AsyncResult that keeps the server response data, debug and error information.
+ *
+ * There are two sources of async result in this library:
+ *
+ * 1. From user provided with async application (function).
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, aResult);`
+ *
+ * 2. From dynamic allocation in the async client.
+ *
+ * For example:
+ *
+ * `Database.get(aClient, "/test/int", options, asyncCB);`
+ *
+ * From source 1, the async result (`aResult`) shall be defined globally to use in async application because of the static data is needed for use while running the sync task.
+ *
+ * From source 2, the async client (`aClient`) shall be defined globally to use in async application too to make sure the instance of async result was existed or valid while running the sync task.
+ *
+ * If async result was destroyed (destructed or not existed) before it was used by async task handler, the danglig pointer problem will be occurred.
+ *
+ * Note that, the async client object used in authentication task shoul be defined globally as it is async task.
  */
 
 #include <Arduino.h>