mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-31 00:03:08 +03:00
Update libssh2_channel_set_blocking.3 and add
libssh2_session_set_blocking.3
This commit is contained in:
@ -1,4 +1,4 @@
|
|||||||
# $Id: Makefile.am,v 1.23 2007/06/14 17:15:32 jehousley Exp $
|
# $Id: Makefile.am,v 1.24 2007/06/14 17:23:13 jehousley Exp $
|
||||||
|
|
||||||
EXTRA_DIST = template.3
|
EXTRA_DIST = template.3
|
||||||
|
|
||||||
@ -35,6 +35,7 @@ dist_man_MANS =
|
|||||||
libssh2_session_last_error.3 \
|
libssh2_session_last_error.3 \
|
||||||
libssh2_session_method_pref.3 \
|
libssh2_session_method_pref.3 \
|
||||||
libssh2_session_methods.3 \
|
libssh2_session_methods.3 \
|
||||||
|
libssh2_session_set_blocking.3 \
|
||||||
libssh2_session_startup.3 \
|
libssh2_session_startup.3 \
|
||||||
libssh2_poll.3 \
|
libssh2_poll.3 \
|
||||||
libssh2_poll_channel_read.3 \
|
libssh2_poll_channel_read.3 \
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
.\" $Id: libssh2_channel_set_blocking.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
|
.\" $Id: libssh2_channel_set_blocking.3,v 1.5 2007/06/14 17:23:13 jehousley Exp $
|
||||||
.\"
|
.\"
|
||||||
.TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
.TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
@ -10,19 +10,19 @@ void
|
|||||||
libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking);
|
libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking);
|
||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
Set or clear blocking mode on the selected channel. If a read is performed on
|
|
||||||
a channel with no data currently available, a blocking channel will wait for
|
|
||||||
data to arrive and return what it receives. A non-blocking channel will return
|
|
||||||
immediately with an empty buffer. If a write is performed on a channel with
|
|
||||||
no room for more data, a blocking channel will wait for room. A non-blocking
|
|
||||||
channel will return immediately without writing anything.
|
|
||||||
|
|
||||||
\fIchannel\fP - channel stream to set or clean blocking status on.
|
\fIchannel\fP - channel stream to set or clean blocking status on.
|
||||||
|
|
||||||
\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to
|
\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to
|
||||||
make it non-blocking.
|
make it non-blocking.
|
||||||
|
|
||||||
|
Currently this is just a short cut call to
|
||||||
|
.BR libssh2_session_set_blocking(3)
|
||||||
|
and therefore will affect the session and all channels.
|
||||||
|
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
None
|
None
|
||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
.BR libssh2_session_set_blocking(3)
|
||||||
.BR libssh2_channel_read_ex(3)
|
.BR libssh2_channel_read_ex(3)
|
||||||
.BR libssh2_channel_write_ex(3)
|
.BR libssh2_channel_write_ex(3)
|
||||||
|
32
docs/libssh2_session_set_blocking.3
Normal file
32
docs/libssh2_session_set_blocking.3
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
.\" $Id: libssh2_session_set_blocking.3,v 1.1 2007/06/14 17:23:13 jehousley Exp $
|
||||||
|
.\"
|
||||||
|
.TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
||||||
|
.SH NAME
|
||||||
|
libssh2_session_set_blocking - set or clear blocking mode on session
|
||||||
|
.SH SYNOPSIS
|
||||||
|
#include <libssh2.h>
|
||||||
|
|
||||||
|
void
|
||||||
|
libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);
|
||||||
|
|
||||||
|
.SH DESCRIPTION
|
||||||
|
\fIsession\fP - session instance as returned by
|
||||||
|
.BR libssh2_session_init(3)
|
||||||
|
|
||||||
|
\fIblocking\fP - 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 sessoin. This will
|
||||||
|
instantly affect any channels associtated 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.
|
||||||
|
|
||||||
|
.SH RETURN VALUE
|
||||||
|
None
|
||||||
|
|
||||||
|
.SH SEE ALSO
|
||||||
|
.BR libssh2_session_init(3)
|
Reference in New Issue
Block a user