Function openthread_sys::otSrpClientRemoveService

source ·

pub unsafe extern "C" fn otSrpClientRemoveService(
    aInstance: *mut otInstance,
    aService: *mut otSrpClientService
) -> otError

Expand description

Requests a service to be unregistered with server.

After a successful call to this function, otSrpClientCallback will be called to report the status of remove request with SRP server.

The otSrpClientService instance being pointed to by @p aService MUST persist and remain unchanged after returning from this function (with OT_ERROR_NONE). OpenThread will keep the service instance during the remove process. Only after the otSrpClientCallback is called indicating the service instance is removed from SRP client service list and can be be freed/reused.

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

@retval OT_ERROR_NONE The removal of service started successfully. The otSrpClientCallback will be called to report the status. @retval OT_ERROR_NOT_FOUND The service could not be found in the list.