libssh2/share/man/man3/libssh2_channel_forward_cancel.3

   1 .\" $Id: libssh2_channel_forward_cancel.3,v 1.1 2007/06/13 19:53:09 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_forward_cancel - cancel a forwarded TCP port
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener);
  11
  12 .SH DESCRIPTION
  13 /fIlistener/fP - Forwarding listener instance as returned by
  14 .BR libssh2_channel_forward_listen(3)
  15
  16 Instruct the remote host to stop listening for new connections on a previously requested host/port.
  17
  18 .SH RETURN VALUE
  19 Return 0 on success or negative on failure.  It returns
  20 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  21 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  22
  23 .SH ERRORS
  24 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  25
  26 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  27
  28 .SH SEE ALSO
  29 .BR libssh2_channel_forward_listen(3)