From d4c1ecabd9a8dfe8415acbe782985a7c96e2346d Mon Sep 17 00:00:00 2001 From: xiaofei0800 <54530729+xiaofei0800@users.noreply.github.com> Date: Fri, 17 Nov 2023 15:26:12 +0800 Subject: [PATCH] Update API docs for retry. (#37) --- include/tquic.h | 2 +- src/ffi.rs | 2 +- website/docs/api_reference/c_quic.md | 11 ++++++++++- .../current/api_reference/c_quic.md | 11 ++++++++++- 4 files changed, 22 insertions(+), 4 deletions(-) diff --git a/include/tquic.h b/include/tquic.h index 149573f5e..bb3175f9e 100644 --- a/include/tquic.h +++ b/include/tquic.h @@ -390,7 +390,7 @@ void quic_config_enable_stateless_reset(struct quic_config_t *config, bool enabl void quic_config_set_address_token_lifetime(struct quic_config_t *config, uint64_t seconds); /** - * Set the key for address token generation. It also enables retry. + * Set the key for address token generation. * The token_key_len should be a multiple of 16. */ int quic_config_set_address_token_key(struct quic_config_t *config, diff --git a/src/ffi.rs b/src/ffi.rs index a4e941f38..aec20bea3 100644 --- a/src/ffi.rs +++ b/src/ffi.rs @@ -250,7 +250,7 @@ pub extern "C" fn quic_config_set_address_token_lifetime(config: &mut Config, se config.set_address_token_lifetime(seconds); } -/// Set the key for address token generation. It also enables retry. +/// Set the key for address token generation. /// The token_key_len should be a multiple of 16. #[no_mangle] pub extern "C" fn quic_config_set_address_token_key( diff --git a/website/docs/api_reference/c_quic.md b/website/docs/api_reference/c_quic.md index 0e2bd9df4..de3b57e6c 100644 --- a/website/docs/api_reference/c_quic.md +++ b/website/docs/api_reference/c_quic.md @@ -211,10 +211,19 @@ int quic_config_set_address_token_key(struct quic_config_t *config, const uint8_t *token_keys, size_t token_keys_len); ``` -* Set the key for address token generation. It also enables retry. +* Set the key for address token generation. The `token_key_len` should be a multiple of 16. +#### quic_config_enable_retry +```c +void quic_config_enable_retry(struct quic_config_t *config, + bool enabled); +``` +* Set whether stateless retry is allowed. +* Default is not allowed. + + #### quic_config_set_cid_len ```c void quic_config_set_cid_len(struct quic_config_t *config, diff --git a/website/i18n/zh/docusaurus-plugin-content-docs/current/api_reference/c_quic.md b/website/i18n/zh/docusaurus-plugin-content-docs/current/api_reference/c_quic.md index dc6835922..a84fc3af5 100644 --- a/website/i18n/zh/docusaurus-plugin-content-docs/current/api_reference/c_quic.md +++ b/website/i18n/zh/docusaurus-plugin-content-docs/current/api_reference/c_quic.md @@ -208,10 +208,19 @@ int quic_config_set_address_token_key(struct quic_config_t *config, const uint8_t *token_keys, size_t token_keys_len); ``` -* 设置生成地址令牌的密钥。设置后会同时启用Retry机制。 +* 设置生成地址令牌的密钥。 参数`token_key_len`应该是16的倍数。 +#### quic_config_enable_retry +```c +void quic_config_enable_retry(struct quic_config_t *config, + bool enabled); +``` +* 设置是否启用Retry机制。 +* 默认禁用。 + + #### quic_config_set_cid_len ```c void quic_config_set_cid_len(struct quic_config_t *config,