openthread_sys

Function otSrpClientClearService

Source
pub unsafe extern "C" fn otSrpClientClearService(
    aInstance: *mut otInstance,
    aService: *mut otSrpClientService,
) -> otError
Expand description

Clears a service, immediately removing it from the client service list.

Unlike otSrpClientRemoveService() which sends an update message to the server to remove the service, this function clears the service from the client’s service list without any interaction with the server. On a successful call to this function, the otSrpClientCallback will NOT be called and the @p aService entry can be reclaimed and re-used by the caller immediately.

Can be used along with a subsequent call to otSrpClientAddService() (potentially reusing the same @p aService entry with the same service and instance names) to update some of the parameters in an existing service.

@param[in] aInstance A pointer to the OpenThread instance. @param[in] aService A pointer to a otSrpClientService instance to delete.

@retval OT_ERROR_NONE The @p aService is deleted successfully. It can be reclaimed and re-used immediately. @retval OT_ERROR_NOT_FOUND The service could not be found in the list.