mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
b889b39945
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
43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_session_set_blocking
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_session_init_ex(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_session_set_blocking - set or clear blocking mode on session
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
void
|
|
libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*session* - session instance as returned by libssh2_session_init_ex(3)
|
|
|
|
*blocking* - Set to a non-zero value to make the channel block, or zero to
|
|
make it non-blocking.
|
|
|
|
Set or clear blocking mode on the selected on the session. This will
|
|
instantly affect any channels associated with this session. If a read is
|
|
performed on a session with no data currently available, a blocking session
|
|
will wait for data to arrive and return what it receives. A non-blocking
|
|
session will return immediately with an empty buffer. If a write is performed
|
|
on a session with no room for more data, a blocking session will wait for
|
|
room. A non-blocking session will return immediately without writing
|
|
anything.
|
|
|
|
# RETURN VALUE
|
|
|
|
None
|