Skip to content

Commit 7243087

Browse files
committed
Update the header file (again)
1 parent 6c1db7c commit 7243087

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Diff for: ios/MullvadRustRuntime/include/mullvad_rust_runtime.h

+6-3
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,18 @@ struct EncryptedDnsProxyState *encrypted_dns_proxy_init(void);
2828
*
2929
* # Safety
3030
* `ptr` must be a valid, exclusive pointer to `EncryptedDnsProxyState`, initialized
31-
* by `encrypted_dns_proxy_init`. This function is not thread safe.
31+
* by `encrypted_dns_proxy_init`. This function is not thread safe, and should only be called
32+
* once.
3233
*/
3334
void encrypted_dns_proxy_free(struct EncryptedDnsProxyState *ptr);
3435

3536
/**
3637
* # Safety
3738
* encrypted_dns_proxy must be a valid, exclusive pointer to `EncryptedDnsProxyState`, initialized
3839
* by `encrypted_dns_proxy_init`. This function is not thread safe.
39-
* `proxy_handle` must be pointing to a valid memory region for the size of a `ProxyHandle`
40+
* `proxy_handle` must be pointing to a valid memory region for the size of a `ProxyHandle`. This
41+
* function is not thread safe, but it can be called repeatedly. Each successful invocation should
42+
* clean up the resulting proxy via `[encrypted_dns_proxy_stop]`.
4043
*
4144
* `proxy_handle` will only contain valid values if the return value is zero. It is still valid to
4245
* deallocate the memory.
@@ -47,7 +50,7 @@ int32_t encrypted_dns_proxy_start(struct EncryptedDnsProxyState *encrypted_dns_p
4750
/**
4851
* # Safety
4952
* `proxy_config` must be a valid pointer to a `ProxyHandle` as initialized by
50-
* [`encrypted_dns_proxy_start`].
53+
* [`encrypted_dns_proxy_start`]. It should only ever be called once.
5154
*/
5255
int32_t encrypted_dns_proxy_stop(struct ProxyHandle *proxy_config);
5356

0 commit comments

Comments
 (0)