mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-12-06 19:41:15 +01:00
Add comment explaining different channel close functions
This commit is contained in:
@@ -1057,6 +1057,19 @@ channel_set_cell_handlers(channel_t *chan,
|
||||
chan->var_cell_handler)) channel_process_cells(chan);
|
||||
}
|
||||
|
||||
/*
|
||||
* On closing channels
|
||||
*
|
||||
* There are three functions that close channels, for use in
|
||||
* different circumstances:
|
||||
*
|
||||
* - Use channel_mark_for_close() for most cases
|
||||
* - Use channel_close_from_lower_layer() if you are connection_or.c
|
||||
* and the other end closes the underlying connection.
|
||||
* - Use channel_close_for_error() if you are connection_or.c and
|
||||
* some sort of error has occurred.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Mark a channel for closure
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user