commit 3db3daa663e9fe41f87993f4580cf3a8e6bab27c Author: Andrea Shepard <andrea@torproject.org> Date: Tue Nov 13 18:50:37 2012 -0800 Add comment explaining different channel close functions --- src/or/channel.c | 13 +++++++++++++ 1 files changed, 13 insertions(+), 0 deletions(-) diff --git a/src/or/channel.c b/src/or/channel.c index 16dd9f9..625d957 100644 --- a/src/or/channel.c +++ b/src/or/channel.c @@ -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 *