1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-10-24 14:53:03 +03:00
Files
libssh2/docs/libssh2_channel_forward_accept.md
Viktor Szakats b889b39945 docs: convert man page sources to "curldown" format
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.

- add options to not build the `.3` man pages:
  - autotools: `--disable-docs`
  - cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
  manually fixed copyrights, inline function references and a couple
  of other things.

Credits-to: Daniel Stenberg

Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671

Closes #1660
2025-10-09 04:05:38 +02:00

38 lines
816 B
Markdown

---
c: Copyright (C) The libssh2 project and its contributors.
SPDX-License-Identifier: BSD-3-Clause
Title: libssh2_channel_forward_accept
Section: 3
Source: libssh2
See-also:
- libssh2_channel_forward_listen_ex(3)
---
# NAME
libssh2_channel_forward_accept - accept a queued connection
# SYNOPSIS
~~~c
#include <libssh2.h>
LIBSSH2_CHANNEL *
libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener);
~~~
# DESCRIPTION
*listener* is a forwarding listener instance as returned by
**libssh2_channel_forward_listen_ex(3)**.
# RETURN VALUE
A newly allocated channel instance or NULL on failure.
# ERRORS
When this function returns NULL use *libssh2_session_last_errno(3)* to
extract the error code. If that code is *LIBSSH2_ERROR_EAGAIN*, the
session is set to do non-blocking I/O but the call would block.