Trident IoT Z-Wave SDK
 
Loading...
Searching...
No Matches
cc_user_credential_handlers_database.h File Reference

User Credential database related handlers. More...

+ Include dependency graph for cc_user_credential_handlers_database.h:

Go to the source code of this file.

Functions

received_frame_status_t CC_UserCredential_UserSet_handler (cc_handler_input_t *input)
 
received_frame_status_t CC_UserCredential_UserGet_handler (cc_handler_input_t *input)
 
received_frame_status_t CC_UserCredential_CredentialSet_handler (u3c_operation_type_t operation_type, u3c_credential_t *p_credential, RECEIVE_OPTIONS_TYPE_EX *p_rx_options)
 
bool CC_UserCredential_CredentialGet_handler (cc_handler_input_t *input, u3c_credential_metadata_t *p_metadata, u3c_credential_report_tx_callback_t callback)
 

Detailed Description

User Credential database related handlers.

Command handlers for reading, adding, modifying and removing users and credentials stored in the database.

SPDX-License-Identifier: BSD-3-Clause SPDX-FileCopyrightText: 2023 Silicon Laboratories Inc.

Function Documentation

◆ CC_UserCredential_CredentialGet_handler()

bool CC_UserCredential_CredentialGet_handler ( cc_handler_input_t * input,
u3c_credential_metadata_t * p_metadata,
u3c_credential_report_tx_callback_t callback )

Called upon receiving a Credential Get frame.

Parameters
[in]inputDetails of the incoming frame
[in]p_metadataPointer to the requested credential's details
[in]callbackCallback to be invoked after processing of the received Credential Get frame. This can be set to CC_UserCredential_CredentialReport_tx() or a custom function that will then invoke CC_UserCredential_CredentialReport_tx().

◆ CC_UserCredential_CredentialSet_handler()

received_frame_status_t CC_UserCredential_CredentialSet_handler ( u3c_operation_type_t operation_type,
u3c_credential_t * p_credential,
RECEIVE_OPTIONS_TYPE_EX * p_rx_options )

Called upon receiving a Credential Set frame.

Parameters
[in]operation_typeOperation to perform on the received credential.
[in]p_credentialPointer to the incoming credential data
[in]p_rx_optionsPointer to the details of the received frame

◆ CC_UserCredential_UserGet_handler()

received_frame_status_t CC_UserCredential_UserGet_handler ( cc_handler_input_t * input)

Called upon receiving a User Get frame.

Parameters
[in]inputDetails of the incoming frame

◆ CC_UserCredential_UserSet_handler()

received_frame_status_t CC_UserCredential_UserSet_handler ( cc_handler_input_t * input)

Called upon receiving a User Set frame.

Parameters
[in]inputDetails of the incoming frame