summaryrefslogtreecommitdiff
path: root/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_block_directions.3
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2015-04-29 09:52:15 -0700
committerAlex Crichton <alex@alexcrichton.com>2015-04-29 09:52:24 -0700
commit40ca99b2d6bc6d4046d2b74438dc9ea769d28c5b (patch)
tree19ab2f7adf3723fe200d1f3ed8362a9367fff598 /libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_block_directions.3
parentcce73bddc574715c0eb77ec5450a76840d43df81 (diff)
downloadssh2-rs-40ca99b2d6bc6d4046d2b74438dc9ea769d28c5b.zip
Update libssh2 to 1.5.0
Diffstat (limited to 'libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_block_directions.3')
-rw-r--r--libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_block_directions.329
1 files changed, 0 insertions, 29 deletions
diff --git a/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_block_directions.3 b/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_block_directions.3
deleted file mode 100644
index 48ffca3..0000000
--- a/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_block_directions.3
+++ /dev/null
@@ -1,29 +0,0 @@
-.TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2 1.0" "libssh2 manual"
-.SH NAME
-libssh2_session_block_directions - get directions to wait for
-.SH SYNOPSIS
-#include <libssh2.h>
-
-int
-libssh2_session_block_directions(LIBSSH2_SESSION *session);
-.SH DESCRIPTION
-\fIsession\fP - Session instance as returned by \fBlibssh2_session_init_ex(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:
-
-LIBSSH2_SESSION_BLOCK_INBOUND: Inbound direction blocked.
-
-LIBSSH2_SESSION_BLOCK_OUTBOUND: Outbound direction blocked.
-
-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_OUTBOUND\fP writefds set should contain the socket.
-.SH AVAILABILITY
-Added in 1.0