espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-10 03:00:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

[srp-client] new feature to allow lease and key lease per service (#8211)

Browse Source 
This commit add a new feature in `Srp::Client` to allow user to
specify the lease and/or key lease intervals explicitly per service.
The lease intervals in a service can be left unspecified(set to zero)
in which case the default lease intervals will be used.

In an SRP Update message, the lease info is included in additional
section in an Update Lease Option record. Therefore the lease values
are applicable to the entire message and all its records. If we have
services with different lease intervals, they need to be registered
in separate messages. This commit updates `Srp::Client` to implement
such a mechanism. When preparing an SRP message, we first determine
the lease and key lease intervals and ensure the services using
matching intervals are included in the message.

This commit also updates and simplifies the "single service mode"
functionality to use the newly added mechanism for tracking which
services are included in the message.

This commit adds `test_srp_register_services_diff_lease` which covers
the behavior of the newly added mechanisms.
This commit is contained in:
Abtin Keshavarzian
2022-10-06 18:31:25 -07:00
committed by GitHub
parent a34d1176b9
commit c4b6206f16
13 changed files with 871 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (248)
#define OPENTHREAD_API_VERSION (249)
/**
* @addtogroup api-instance
include/openthread/srp_client.h
+37 -23
View File
@@ -88,28 +88,34 @@ typedef struct otSrpClientHostInfo
* and stay constant after an instance of this structure is passed to OpenThread from `otSrpClientAddService()` or
* `otSrpClientRemoveService()`.
*
* The `mState`, `mData`, `mNext` fields are used/managed by OT core only. Their value is ignored when an instance of
* `otSrpClientService` is passed in `otSrpClientAddService()` or `otSrpClientRemoveService()` or other functions. The
* caller does not need to set these fields.
*
* The `mLease` and `mKeyLease` fields specify the desired lease and key lease intervals for this service. Zero value
* indicates that the interval is unspecified and then the default lease or key lease intervals from
* `otSrpClientGetLeaseInterval()` and `otSrpClientGetKeyLeaseInterval()` are used for this service. If the key lease
* interval (whether set explicitly or determined from the default) is shorter than the lease interval for a service,
* SRP client will re-use the lease interval value for key lease interval as well. For example, if in service `mLease`
* is explicitly set to 2 days and `mKeyLease` is set to zero and default key lease is set to 1 day, then when
* registering this service, the requested key lease for this service is also set to 2 days.
*
*/
typedef struct otSrpClientService
{
const char * mName; ///< The service name labels (e.g., "_chip._udp", not the full domain name).
const char * mInstanceName; ///< The service instance name label (not the full name).
const char *const * mSubTypeLabels; ///< Array of service sub-type labels (must end with `NULL` or can be `NULL`).
const otDnsTxtEntry *mTxtEntries; ///< Array of TXT entries (number of entries is given by `mNumTxtEntries`).
uint16_t mPort; ///< The service port number.
uint16_t mPriority; ///< The service priority.
uint16_t mWeight; ///< The service weight.
uint8_t mNumTxtEntries; ///< Number of entries in the `mTxtEntries` array.
/**
* @note The following fields are used/managed by OT core only. Their values do not matter and are ignored when an
* instance of `otSrpClientService` is passed in `otSrpClientAddService()` or `otSrpClientRemoveService()`. The
* user should not modify these fields.
*
*/
otSrpClientItemState mState; ///< Service state (managed by OT core).
uint32_t mData; ///< Internal data (used by OT core).
struct otSrpClientService *mNext; ///< Pointer to next entry in a linked-list (managed by OT core).
const char * mName; ///< The service labels (e.g., "_mt._udp", not the full domain name).
const char * mInstanceName; ///< The service instance name label (not the full name).
const char *const * mSubTypeLabels; ///< Array of sub-type labels (must end with `NULL` or can be `NULL`).
const otDnsTxtEntry * mTxtEntries; ///< Array of TXT entries (`mNumTxtEntries` gives num of entries).
uint16_t mPort; ///< The service port number.
uint16_t mPriority; ///< The service priority.
uint16_t mWeight; ///< The service weight.
uint8_t mNumTxtEntries; ///< Number of entries in the `mTxtEntries` array.
otSrpClientItemState mState; ///< Service state (managed by OT core).
uint32_t mData; ///< Internal data (used by OT core).
struct otSrpClientService *mNext; ///< Pointer to next entry in a linked-list (managed by OT core).
uint32_t mLease; ///< Desired lease interval in sec - zero to use default.
uint32_t mKeyLease; ///< Desired key lease interval in sec - zero to use default.
} otSrpClientService;
/**
@@ -359,7 +365,9 @@ uint32_t otSrpClientGetTtl(otInstance *aInstance);
void otSrpClientSetTtl(otInstance *aInstance, uint32_t aTtl);
/**
* This function gets the lease interval used in SRP update requests.
* This function gets the default lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mLease` set to zero.
*
* Note that this is the lease duration requested by the SRP client. The server may choose to accept a different lease
* interval.
@@ -372,7 +380,9 @@ void otSrpClientSetTtl(otInstance *aInstance, uint32_t aTtl);
uint32_t otSrpClientGetLeaseInterval(otInstance *aInstance);
/**
* This function sets the lease interval used in SRP update requests.
* This function sets the default lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mLease` set to zero.
*
* Changing the lease interval does not impact the accepted lease interval of already registered services/host-info.
* It only affects any future SRP update messages (i.e., adding new services and/or refreshes of the existing services).
@@ -385,7 +395,9 @@ uint32_t otSrpClientGetLeaseInterval(otInstance *aInstance);
void otSrpClientSetLeaseInterval(otInstance *aInstance, uint32_t aInterval);
/**
* This function gets the key lease interval used in SRP update requests.
* This function gets the default key lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mKeyLease` set to zero.
*
* Note that this is the lease duration requested by the SRP client. The server may choose to accept a different lease
* interval.
@@ -398,7 +410,9 @@ void otSrpClientSetLeaseInterval(otInstance *aInstance, uint32_t aInterval);
uint32_t otSrpClientGetKeyLeaseInterval(otInstance *aInstance);
/**
* This function sets the key lease interval used in SRP update requests.
* This function sets the default key lease interval used in SRP update requests.
*
* The default interval is used only for `otSrpClientService` instances with `mKeyLease` set to zero.
*
* Changing the lease interval does not impact the accepted lease interval of already registered services/host-info.
* It only affects any future SRP update messages (i.e., adding new services and/or refreshes of existing services).