Skip to content

Files

Latest commit

 

History

History
303 lines (168 loc) · 6.4 KB

async_client.md

File metadata and controls

303 lines (168 loc) · 6.4 KB

AsyncClientClass

Description

The async client class.

class AsyncClientClass

Constructors

  1. 🔹 AsyncClientClass()

Default constructor.

AsyncClientClass()

  1. 🔹 AsyncClientClass(Client &client, bool reconnect = true)

AsyncClientClass(Client &client, bool reconnect = true)

Params:

  • client - The SSL client that working with the network interface.

  • reconnect - Optional The network reconnection option when the network lost connection.

  1. 🔹 AsyncClientClass(Client &client, network_config_data &net)

AsyncClientClass(Client &client, network_config_data &net)

Params:

  • client - The SSL client that working with the network interface.

  • net - The network config data can be obtained from the networking classes via the static function called getNetwork.

  1. 🔹 AsyncClientClass(AsyncTCPConfig &tcpClientConfig, network_config_data &net)

AsyncClientClass(AsyncTCPConfig &tcpClientConfig, network_config_data &net)

Params:

  • tcpClientConfig - The AsyncTCPConfig object. See src/core/AsyncTCPConfig.h

  • net - The network config data can be obtained from the networking classes via the static function called getNetwork.

Functions

  1. 🔹 void setAsyncResult(AsyncResult &result)

Set the external async result to use with the sync task.

If no async result was set (unset) for sync task, the internal async result will be used and shared usage for all sync tasks.

void setAsyncResult(AsyncResult &result)

Params:

  • result - The AsyncResult to set.

  1. 🔹 void unsetAsyncResult()

Unset the external async result use with the sync task.

The internal async result will be used for sync task.

void unsetAsyncResult()

  1. 🔹 bool networkStatus()

Get the network connection status.

bool networkStatus()

Returns:

  • bool - Returns true if network is connected.

  1. 🔹 unsigned long networkLastSeen()

Get the network disconnection time.

unsigned long networkLastSeen()

Returns:

  • unsigned long - The millisec of network successfully connection since device boot.

  1. 🔹 firebase_network_data_type getNetworkType()

Return the current network type.

firebase_network_data_type getNetworkType()

Returns:

  • firebase_network_data_type - The firebase_network_data_type enums are firebase_network_data_default_network, firebase_network_data_generic_network, firebase_network_data_ethernet_network and firebase_network_data_gsm_network.

  1. 🔹 void stopAsync(bool all = false)

Stop and remove the async/sync task from the queue.

void stopAsync(bool all = false)

Params:

  • all - The option to stop and remove all tasks. If false, only running task will be stop and removed from queue.

  1. 🔹 void stopAsync(const String &uid)

Stop and remove the specific async/sync task from the queue.

void stopAsync(const String &uid)

Params:

  • uid - The task identifier of the task to stop and remove from the queue.

  1. 🔹 size_t taskCount() const

Get the number of async/sync tasks that stored in the queue.

size_t taskCount() const

Returns:

  • size_t - The total tasks in the queue.

  1. 🔹 FirebaseError lastError() const

Get the last error information from async client.

FirebaseError lastError() const

Returns:

  • FirebaseError - The FirebaseError object that contains the last error information.

  1. 🔹 String etag() const

Get the response etag.

String etag() const

Returns:

  • String - The response etag header.

  1. 🔹 void setETag(const String &etag)

Set the etag header to the task (DEPRECATED).

The etag can be set via the functions that support etag.

void setEtag(const String &etag)

Params:

  • etag - The ETag to set to the task.

  1. 🔹 void setSyncSendTimeout(uint32_t timeoutSec)

Set the sync task's send timeout in seconds.

void setSyncSendTimeout(uint32_t timeoutSec)

Params:

  • timeoutSec - The TCP write timeout in seconds.

  1. 🔹 void setSyncReadTimeout(uint32_t timeoutSec)

Set the sync task's read timeout in seconds.

void setSyncReadTimeout(uint32_t timeoutSec)

Params:

  • timeoutSec - The TCP read timeout in seconds.

  1. 🔹 void setSessionTimeout(uint32_t timeoutSec)

Set the TCP session timeout in seconds.

void setSessionTimeout(uint32_t timeoutSec)

Params:

  • timeoutSec - The TCP session timeout in seconds.

  1. 🔹 void setSSEFilters(const String &filter = "")

Filtering response payload for for Relatime Database SSE streaming.

This function is available since v1.2.1.

This is optional to allow specific events filtering.

The following event keywords are supported.

get - To allow the http get response (first put event since stream connected).

put - To allow the put event.

patch - To allow the patch event.

keep-alive - To allow the keep-alive event.

cancel - To allow the cancel event.

auth_revoked - To allow the auth_revoked event.

You can separate each keyword with comma or space.

To clear all prevousely set filter to allow all Stream events, use AsyncClientClass::setSSEFilters().

This will overwrite the value sets by RealtimeDatabase::setSSEFilters.

Example

    
// To all all tream events.
aClient.setSSEFilters("get,put,patch,keep-alive,cancel,auth_revoked");
    
// SSE streaming
Database.get(aClient, "/path/to/stream/data", cb, true);
void setSSEFilters(const String &filter = "")

Params:

  • filter - The event keywords for filtering.

  1. 🔹 void setNetwork(Client &client, network_config_data &net)

Set the network interface.

The SSL client set here should work for the type of network set.

void setNetwork(Client &client, network_config_data &net)

Params:

  • client - The SSL client that working with this type of network interface.

  • net - The network config data can be obtained from the networking classes via the static function called getNetwork.