nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-24 20:33:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document lifespan of return values of the _remote_descr() funcs

Browse Source
This commit is contained in:
Nick Mathewson 2012-10-17 11:29:37 -04:00
parent 26946c659b
commit cb9d123764
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/or/channel.c
View File

@ -3475,8 +3475,10 @@ channel_listener_dump_transport_statistics(channel_listener_t *chan_l,
* This function return a test provided by the lower layer of the remote * This function return a test provided by the lower layer of the remote
* endpoint for this channel; it should specify the actual address connected * endpoint for this channel; it should specify the actual address connected
* to/from. * to/from.
*
* Subsequent calls to channel_get_{actual,canonical}_remote_{address,descr}
* may invalidate the return value from this function.
*/ */
const char * const char *
channel_get_actual_remote_descr(channel_t *chan) channel_get_actual_remote_descr(channel_t *chan)
{ {
@ -3487,7 +3489,12 @@ channel_get_actual_remote_descr(channel_t *chan)
return chan->get_remote_descr(chan, GRD_FLAG_ORIGINAL); return chan->get_remote_descr(chan, GRD_FLAG_ORIGINAL);
} }
/** DOCDOC */ /**
* Return the text address of the remote endpoint.
*
* Subsequent calls to channel_get_{actual,canonical}_remote_{address,descr}
* may invalidate the return value from this function.
*/
const char * const char *
channel_get_actual_remote_address(channel_t *chan) channel_get_actual_remote_address(channel_t *chan)
{ {
@ -3501,8 +3508,10 @@ channel_get_actual_remote_address(channel_t *chan)
* This function return a test provided by the lower layer of the remote * This function return a test provided by the lower layer of the remote
* endpoint for this channel; it should use the known canonical address for * endpoint for this channel; it should use the known canonical address for
* this OR's identity digest if possible. * this OR's identity digest if possible.
*
* Subsequent calls to channel_get_{actual,canonical}_remote_{address,descr}
* may invalidate the return value from this function.
*/ */
const char * const char *
channel_get_canonical_remote_descr(channel_t *chan) channel_get_canonical_remote_descr(channel_t *chan)
{ {