aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-05-03 18:32:33 +0000
committerAndreas Schneider <mail@cynapses.org>2009-05-03 18:32:33 +0000
commitb27e5b67856993be048021ad8e71350a3113f31e (patch)
treef0bddb705faf9d71754bd96f64b2751842f190c2
parent9827cac4759000e5f954275ffef88b3584b76d21 (diff)
downloadlibssh-b27e5b67856993be048021ad8e71350a3113f31e.tar.gz
libssh-b27e5b67856993be048021ad8e71350a3113f31e.tar.xz
libssh-b27e5b67856993be048021ad8e71350a3113f31e.zip
Improve channel_send_eof().
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@687 7dcaeef0-15fb-0310-b436-a5af3365683c
-rw-r--r--libssh/channels.c19
1 files changed, 12 insertions, 7 deletions
diff --git a/libssh/channels.c b/libssh/channels.c
index ec9bdd8b..c1d6511e 100644
--- a/libssh/channels.c
+++ b/libssh/channels.c
@@ -752,13 +752,18 @@ void channel_free(CHANNEL *channel) {
leave_function();
}
-/** it doesn't close the channel. You may still read from it but not write.
- * \brief send an end of file on the channel
- * \param channel channel
- * \return SSH_ERROR on error\n
- * SSH_SUCCESS on success
- * \see channel_close()
- * \see channel_free()
+/**
+ * @brief Send an end of file on the channel.
+ *
+ * This doesn't close the channel. You may still read from it but not write.
+ *
+ * @param channel The channel to send the eof to.
+ *
+ * @return SSH_SUCCESS on success\n
+ * SSH_ERROR on error\n
+ *
+ * @see channel_close()
+ * @see channel_free()
*/
int channel_send_eof(CHANNEL *channel){
SSH_SESSION *session = channel->session;