libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_send_eof - send EOF to remote server
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel);
12
.fi
13
.SH DESCRIPTION
14
Tell the remote host that no further data will be sent on the specified
15
channel. Processes typically interpret this as a closed stdin descriptor.
16
.SH RETURN VALUE
17
Return 0 on success or negative on failure. It returns
18
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
19
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
20
.SH ERRORS
21
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
22
.SH SEE ALSO
23
.BR libssh2_channel_wait_eof(3)
24
.BR libssh2_channel_eof(3)
25