PUSH_UPDATE: improve feature description #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Lev Stipakov <[email protected]>
ordex
requested changes
Oct 31, 2024
| <sourcecode> | ||
| PUSH_UPDATE,route 10.10.10.0 255.255.255.0,-dns | ||
| PUSH_UPDATE,dns server 0 10.10.10.1,route-metric 100 |
| </t> | ||
| <t> | ||
| This message includes dynamic configuration options that can be pushed from the server to the client without reconnecting. | ||
| These options augment existing options. Options with the same name are replaced. To remove an option, it should be prefixed | ||
| with <tt>-</tt>. For example, the following code replaces all routes (if there were any) with the provided one and removes the <tt>dns</tt> option: | ||
| These options augment existing ones. For example, the following command only adds a DNS server and updates the route metrics |
There was a problem hiding this comment.
is augment the proper term here? Normally that refers to "adding additional value/capabilities" to something.
What do you think about "join"? This way it's clear that they ultimately end up in the same option set, as if they were all provided at the same time.
| Options with the same name, previously pushed with <tt>PUSH_REPLY</tt> or <tt>PUSH_UPDATE</tt>, are replaced. | ||
| For instance, the following command removes all existing routes and adds two new routes: | ||
| <sourcecode> | ||
| PUSH_UPDATE,route 10.1.0.0 255.255.0.0,route 10.2.0.0 255.255.0.0 |
| <t> | ||
| To remove an option, it should be prefixed with <tt>-</tt>. The following example removes all existing <tt>dns</tt> options: | ||
| <sourcecode> | ||
| PUSH_UPDATE,-dns |
| Options prefixed with <tt>?</tt> are considered optional. The client MAY support them. If the client cannot support some optional options, | ||
| they can be ignored, and the client does not have to reconnect. This also applies to removal. Example syntax: | ||
| <sourcecode> | ||
| PUSH_UPDATE,-?block-ipv6 | ||
| PUSH_UPDATE,-?block-ipv6 |
| Here client should remove <tt>block-ipv6</tt> option. However, if client does not support updating it, it does not need to reconnect. | ||
| </t> | ||
| Here, the client should remove the <tt>block-ipv6</tt> option. However, if the client does not support updating it, it does not need to reconnect. | ||
| Note that the only valid syntax for removing options without reconnecting on failure is <tt>-?option-name</tt>. |
There was a problem hiding this comment.
can we spell out that the '-' should always come before the '?' ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.