Skip to content
Snippets Groups Projects
Verified Commit 654a60ca authored by Oto Šťáva's avatar Oto Šťáva
Browse files

daemon/session2: comment on event propagation

Minor, but I believe quite important. I stumbled across this while
writing the protocol layer article and thought it was not emphasized
enough in the docs.
parent 672dd13d
Branches
Tags
1 merge request!1603daemon/session2: comment on event propagation
Pipeline #129454 waiting for manual action with stages
in 10 minutes and 44 seconds
......@@ -575,7 +575,12 @@ enum protolayer_event_cb_result {
*
* When `PROTOLAYER_EVENT_PROPAGATE` is returned, iteration over the sequence
* of layers continues. When `PROTOLAYER_EVENT_CONSUME` is returned, iteration
* stops. */
* stops.
*
* **IMPORTANT:** A well-behaved layer will **ALWAYS** propagate events it knows
* nothing about. Only ever consume events you actually have good reason to
* consume (like TLS consumes `CONNECT` from TCP, because it needs to perform
* its own handshake first). */
typedef enum protolayer_event_cb_result (*protolayer_event_cb)(
enum protolayer_event_type event, void **baton,
struct session2 *session, void *sess_data);
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment