lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00
Code Activity

0.19 is now 1.0

Browse Source
This commit is contained in:
Daniel Stenberg
2008-12-22 12:51:27 +00:00
parent 8eba2961ac
commit d602478e87
2 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/libssh2_session_block_directions.3
View File

@ -1,6 +1,6 @@
.\" $Id: libssh2_session_block_directions.3,v 1.1 2008/11/27 12:19:43 bagder Exp $
.\" $Id: libssh2_session_block_directions.3,v 1.2 2008/12/22 12:51:27 bagder Exp $
.\"
.TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2 0.19" "libssh2 manual"
.TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2 1.0" "libssh2 manual"
.SH NAME
libssh2_session_block_directions - get directions that socket should wait for before calling libssh2 function again
.SH SYNOPSIS
@ -8,17 +8,14 @@ libssh2_session_block_directions - get directions that socket should wait for be
int
libssh2_session_block_directions(LIBSSH2_SESSION *session);
.SH DESCRIPTION
\fIsession\fP - Session instance as returned by
.BR libssh2_session_init(3)
\fIsession\fP - Session instance as returned by \fBlibssh2_session_init(3)\fP
When any of libssh2 functions return \fBLIBSSH2_ERROR_EAGAIN\fP an application
should wait for the socket to have data available for reading or
writing. Depending on the return value of
\fIlibssh2_session_block_directions(3)\fP an application should wait for read,
write or both.
.SH RETURN VALUE
Returns the set of directions as a binary mask. Can be a combination of:
@ -30,3 +27,5 @@ Application should wait for data to be available for socket prior to calling a
libssh2 function again. If \fBLIBSSH2_SESSION_BLOCK_INBOUND\fP is set select
should contain the session socket in readfds set. Correspondingly in case of
\fBLIBSSH2_SESSION_BLOCK_INBOUND\fP writefds set should contain the socket.
.SH AVAILABILITY
Added in 1.0