generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update to match current code and add errors

Browse Source
This commit is contained in:
James Housley 2007-06-13 13:06:48 +00:00
parent 3e0cc45d10
commit 084500e9ca
2 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/libssh2_channel_forward_listen_ex.3
View File

@ -1,4 +1,4 @@
.\" $Id: libssh2_channel_forward_listen_ex.3,v 1.4 2007/06/13 12:51:10 jehousley Exp $
.\" $Id: libssh2_channel_forward_listen_ex.3,v 1.5 2007/06/13 13:06:48 jehousley Exp $
.\"
.TH libssh2_channel_forward_listen_ex 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
@ -6,14 +6,12 @@ libssh2_channel_forward_listen_ex - listen to inbound connections
.SH SYNOPSIS
#include <libssh2.h>
LIBSSH2_LISTENER * libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session,
char *host,
int port,
int *bound_port,
int queue_maxsize);
LIBSSH2_LISTENER *
libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, char *host, int port, int *bound_port, int queue_maxsize);
LIBSSH2_LISTENER *
libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port);
LIBSSH2_LISTENER * libssh2_channel_forward_listen(LIBSSH2_SESSION *session,
int port);
.SH DESCRIPTION
Instruct the remote SSH server to begin listening for inbound TCP/IP
connections. New connections will be queued by the library until accepted by
@ -37,7 +35,14 @@ rejecting further attempts.
.SH RETURN VALUE
A newly allocated LIBSSH2_LISTENER instance or NULL on failure.
.SH ERRORS
LIBSSH2_ERROR_EAGAIN
Marked for non-blocking I/O but the call would block.
\fILIBSSH2_ERROR_ALLOC\fP - >An internal memory allocation call failed.
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on the socket.
\fILIBSSH2_ERROR_REQUEST_DENIED\fP - The remote server refused the request.
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
.SH SEE ALSO
.BI libssh2_channel_forward_accept(3)
.BR libssh2_channel_forward_accept(3)

8
docs/libssh2_channel_wait_eof.3
View File

@ -1,4 +1,4 @@
.\" $Id: libssh2_channel_wait_eof.3,v 1.3 2007/06/13 12:51:11 jehousley Exp $
.\" $Id: libssh2_channel_wait_eof.3,v 1.4 2007/06/13 13:11:03 jehousley Exp $
.\"
.TH libssh2_channel_wait_eof 3 "1 June 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
@ -6,7 +6,8 @@ libssh2_channel_wait_eof - wait for the remote to reply to an EOF request
.SH SYNOPSIS
#include <libssh2.h>
int libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel);
int
libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel);
.SH DESCRIPTION
Wait for the remote end to acknowledge an EOF request.
@ -16,4 +17,5 @@ Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.SH SEE ALSO
.BI libssh2_channel_send_eof(3), libssh2_channel_eof(3)
.BR libssh2_channel_send_eof(3)
.BR libssh2_channel_eof(3)