mirror/openvpn3
0
0
Fork 0
mirror of https://github.com/OpenVPN/openvpn3.git synced 2024-09-19 19:52:15 +02:00
Code

tunbase.hpp: add doxygen to apply_push_update()

Browse Source 
Commit

  adacc16 ("push update: base implementation")

added apply_push_update() method to TunClient class
but didn't add doxygen comments. This adds missing
comments.

Signed-off-by: Lev Stipakov <lev@openvpn.net>
This commit is contained in:
Lev Stipakov 2024-09-04 14:55:23 +03:00 committed by Jenkins-dev
parent 906434b237
commit 3d3e333c0e
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
openvpn/tun/client/tunbase.hpp
View File

@ -64,7 +64,18 @@ struct TunClient : public virtual RC<thread_unsafe_refcount>
virtual void adjust_mss(int mss){};
virtual void apply_push_update(const OptionList &, TransportClient &){};
/**
* @brief Notifies tun client about received PUSH_UPDATE control channel message.
*
* The merging of exiting and incoming options (including removing options)
* happens before this call, so implementations are supposed to only undo
* existing options and apply the new ones, normally by calling stop()
* and tun_start().
*
* @param opt merged options, to be applied by implementation
* @param cli transport client, passed to tun_start() call
*/
virtual void apply_push_update(const OptionList &opt, TransportClient &cli){};
};
// Base class for parent of tun interface object, used to