Trust Center Keepalive#

Callbacks for Trust Center Keepalive Component.

Callbacks#

bool
emberAfTrustCenterKeepaliveOverwriteDefaultTimingCallback(uint16_t *baseTimeSeconds, uint16_t *jitterTimeSeconds)

Overwrite default timing parameters. This function is called by the Trust Center Keep Alive plugin when the Trust Center Keep Alive process is started. Applications may consume this callback and have it return true to have the Trust Center Keep Alive plugin code to start the keep alive process with timing parameters other than the default values. If this callback returns false, the Trust Center Keep Alive plugin code will proceed to start with the default timing parameters.

void

Read attributes response callback.

void

Connectivity established. This function is called by the Trust Center Keepalive plugin when a read attribute response command from the trust center is received after trust center connectivity had previously been lost. This function is also called after a match descriptor response.

bool

Serverless Keepalive supported. This function is called by the Trust Center Keep Alive plugin when service discovery receives a response indicating that the server does not support the cluster. Applications may consume this callback and have it return true to have the Trust Center Keep Alive plugin code to still start the keep alive process even if the server cluster is not discovered. If this callback returns false, the Trust Center Keep Alive plugin code will only proceed to start the process in case the service discovery was successful.

bool

Serverless Keepalive enabled. This function is called by the Trust Center Keep Alive plugin when a service discovery is done, a response has arrived and emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback() returned true. Applications may consume this callback and have it return true to have the Trust Center Keep Alive plugin code to start the keep alive process right away. If this callback returns false, the Trust Center Keep Alive plugin code will return to the disabled state waiting to be enabled.

Callbacks Documentation#

emberAfTrustCenterKeepaliveOverwriteDefaultTimingCallback#

bool emberAfTrustCenterKeepaliveOverwriteDefaultTimingCallback (uint16_t * baseTimeSeconds, uint16_t * jitterTimeSeconds)

Overwrite default timing parameters. This function is called by the Trust Center Keep Alive plugin when the Trust Center Keep Alive process is started. Applications may consume this callback and have it return true to have the Trust Center Keep Alive plugin code to start the keep alive process with timing parameters other than the default values. If this callback returns false, the Trust Center Keep Alive plugin code will proceed to start with the default timing parameters.

Parameters
N/AbaseTimeSeconds

time for keep alive signalling to be set in seconds

N/AjitterTimeSeconds

time for keep alive signalling to be set in seconds

Returns

  • bool


Definition at line 116 of file app/framework/plugin/trust-center-keepalive/trust-center-keepalive.h

sli_zigbee_af_trust_center_keepalive_read_attributes_response_callback#

void sli_zigbee_af_trust_center_keepalive_read_attributes_response_callback (uint8_t * buffer, uint16_t bufLen)

Read attributes response callback.

Parameters
N/Abuffer

Ver.: always

N/AbufLen

Ver.: always


Definition at line 125 of file app/framework/plugin/trust-center-keepalive/trust-center-keepalive.h

emberAfPluginTrustCenterKeepaliveTimeoutCallback#

bool emberAfPluginTrustCenterKeepaliveTimeoutCallback (void )

Timeout.

Parameters
N/A

This function is called by the Trust Center Keepalive plugin when the Trust Center fails to acknowledge enough keepalive messages. Upon timing out, the Trust Center Keepalive plugin code will initiate a search for a new Trust Center, which falls in line with the Trust Center Swapout feature. Applications may consume this callback and have it return true in order to prevent the Trust Center Keepalive plugin code from issuing a Trust Center (insecure) rejoin. Doing so will also give the application a chance to implement its own rejoin algorithm or logic. If this callback returns false, the Trust Center Keepalive plugin code will proceed with issuing a Trust Center rejoin.

Returns

  • bool


Definition at line 144 of file app/framework/plugin/trust-center-keepalive/trust-center-keepalive.h

emberAfPluginTrustCenterKeepaliveConnectivityEstablishedCallback#

void emberAfPluginTrustCenterKeepaliveConnectivityEstablishedCallback (void )

Connectivity established. This function is called by the Trust Center Keepalive plugin when a read attribute response command from the trust center is received after trust center connectivity had previously been lost. This function is also called after a match descriptor response.

Parameters
N/A

Definition at line 152 of file app/framework/plugin/trust-center-keepalive/trust-center-keepalive.h

emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback#

bool emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback (void )

Serverless Keepalive supported. This function is called by the Trust Center Keep Alive plugin when service discovery receives a response indicating that the server does not support the cluster. Applications may consume this callback and have it return true to have the Trust Center Keep Alive plugin code to still start the keep alive process even if the server cluster is not discovered. If this callback returns false, the Trust Center Keep Alive plugin code will only proceed to start the process in case the service discovery was successful.

Parameters
N/A

Returns

  • bool


Definition at line 167 of file app/framework/plugin/trust-center-keepalive/trust-center-keepalive.h

emberAfTrustCenterKeepaliveServerlessIsEnabledCallback#

bool emberAfTrustCenterKeepaliveServerlessIsEnabledCallback (void )

Serverless Keepalive enabled. This function is called by the Trust Center Keep Alive plugin when a service discovery is done, a response has arrived and emberAfPluginTrustCenterKeepaliveServerlessIsSupportedCallback() returned true. Applications may consume this callback and have it return true to have the Trust Center Keep Alive plugin code to start the keep alive process right away. If this callback returns false, the Trust Center Keep Alive plugin code will return to the disabled state waiting to be enabled.

Parameters
N/A

Returns

  • bool


Definition at line 181 of file app/framework/plugin/trust-center-keepalive/trust-center-keepalive.h