libssh2_channel_forward_cancel

Section: libssh2 manual (3)
Updated: 1 Jun 2007
Index Return to Main Contents

NAME

libssh2_channel_forward_cancel - cancel a forwarded TCP port

SYNOPSIS

#include <libssh2.h>

int libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener);

DESCRIPTION

listener - Forwarding listener instance as returned by libssh2_channel_forward_listen_ex(3)

Instruct the remote host to stop listening for new connections on a previously requested host/port.

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.

ERRORS

LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.