File: libssh2_channel_forward_cancel.3

package info (click to toggle)
libssh2 1.2.6-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 3,512 kB
  • ctags: 1,941
  • sloc: ansic: 19,640; sh: 10,525; makefile: 388; awk: 19
file content (29 lines) | stat: -rw-r--r-- 972 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
.\" $Id: libssh2_channel_forward_cancel.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
.\"
.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)