summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2019-08-06 19:12:03 +0200
committerChristian Grothoff <christian@grothoff.org>2019-08-06 19:12:03 +0200
commit6b23a8225efed99498f891b589c7c5171567192b (patch)
tree252f57fe8fda82236de4fe26d8c75a89ff03b05f /src
parent1b0e7d3f59c3236aae3a64b7b19ee827eec4bb9c (diff)
clarify incorrect comment identified by Alessio Vanni on the gnunet-developer mailinglist
Diffstat (limited to 'src')
-rw-r--r--src/cadet/cadet_api.c7
-rw-r--r--src/include/gnunet_cadet_service.h9
2 files changed, 7 insertions, 9 deletions
diff --git a/src/cadet/cadet_api.c b/src/cadet/cadet_api.c
index ff6f15543..7148ab956 100644
--- a/src/cadet/cadet_api.c
+++ b/src/cadet/cadet_api.c
@@ -1050,9 +1050,9 @@ GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
/**
* Create a new channel towards a remote peer.
*
- * If the destination port is not open by any peer or the destination peer
- * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
- * for this channel.
+ * If the destination peer closes the channel after accepting it,
+ * @a disconnects will be called for this channel (unless
+ * #GNUNET_CADET_channel_destroy() was called on this end first).
*
* @param h CADET handle.
* @param channel_cls Closure for the channel. It's given to:
@@ -1060,7 +1060,6 @@ GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
* - Each message type callback in @a handlers
* @param destination Peer identity the channel should go to.
* @param port Identification of the destination port.
- * @param options CadetOption flag field, with all desired option bits set to 1.
* @param window_changes Function called when the transmit window size changes.
* @param disconnects Function called when the channel is disconnected.
* @param handlers Callbacks for messages we care about, NULL-terminated.
diff --git a/src/include/gnunet_cadet_service.h b/src/include/gnunet_cadet_service.h
index ba4d60eb8..819e39353 100644
--- a/src/include/gnunet_cadet_service.h
+++ b/src/include/gnunet_cadet_service.h
@@ -205,9 +205,9 @@ GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p);
/**
* Create a new channel towards a remote peer.
*
- * If the destination port is not open by any peer or the destination peer
- * does not accept the channel, @a disconnects will be called
- * for this channel.
+ * If the destination peer closes the channel after accepting it,
+ * @a disconnects will be called for this channel (unless
+ * #GNUNET_CADET_channel_destroy() was called on this end first).
*
* @param h CADET handle.
* @param channel_cls Closure for the channel. It's given to:
@@ -218,7 +218,6 @@ GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p);
* @param port Identification of the destination port.
* @param window_changes Function called when the transmit window size changes.
* Can be NULL if this data is of no interest.
- * TODO Not yet implemented.
* @param disconnects Function called when the channel is disconnected.
* @param handlers Callbacks for messages we care about, NULL-terminated.
* @return Handle to the channel.
@@ -317,7 +316,7 @@ union GNUNET_CADET_ChannelInfo
*/
const union GNUNET_CADET_ChannelInfo *
GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
- enum GNUNET_CADET_ChannelInfoOption option,
+ enum GNUNET_CADET_ChannelInfoOption option,
...);