summaryrefslogtreecommitdiff
path: root/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3
diff options
context:
space:
mode:
Diffstat (limited to 'libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3')
-rw-r--r--libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.327
1 files changed, 27 insertions, 0 deletions
diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3
new file mode 100644
index 0000000..16f826f
--- /dev/null
+++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3
@@ -0,0 +1,27 @@
+.TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_forward_cancel - cancel a forwarded TCP port
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener);
+
+.SH DESCRIPTION
+\fIlistener\fP - Forwarding listener instance as returned by
+.BR libssh2_channel_forward_listen_ex(3)
+
+Instruct the remote host to stop listening for new connections on a previously requested host/port.
+
+.SH RETURN VALUE
+Return 0 on success or negative on failure. It returns
+LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
+LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+.SH SEE ALSO
+.BR libssh2_channel_forward_listen_ex(3)