File tree 1 file changed +6
-3
lines changed
ios/MullvadRustRuntime/include
1 file changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -28,15 +28,18 @@ struct EncryptedDnsProxyState *encrypted_dns_proxy_init(void);
28
28
*
29
29
* # Safety
30
30
* `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.
32
33
*/
33
34
void encrypted_dns_proxy_free (struct EncryptedDnsProxyState * ptr );
34
35
35
36
/**
36
37
* # Safety
37
38
* encrypted_dns_proxy must be a valid, exclusive pointer to `EncryptedDnsProxyState`, initialized
38
39
* 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]`.
40
43
*
41
44
* `proxy_handle` will only contain valid values if the return value is zero. It is still valid to
42
45
* deallocate the memory.
@@ -47,7 +50,7 @@ int32_t encrypted_dns_proxy_start(struct EncryptedDnsProxyState *encrypted_dns_p
47
50
/**
48
51
* # Safety
49
52
* `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.
51
54
*/
52
55
int32_t encrypted_dns_proxy_stop (struct ProxyHandle * proxy_config );
53
56
You can’t perform that action at this time.
0 commit comments