25 lines
850 B
Groff
25 lines
850 B
Groff
|
.\" Copyright (C) The libssh2 project and its contributors.
|
||
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
||
|
|
.TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
||
|
|
.SH NAME
|
||
|
|
libssh2_channel_send_eof - send EOF to remote server
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <libssh2.h>
|
||
|
|
|
||
|
|
int
|
||
|
|
libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Tell the remote host that no further data will be sent on the specified
|
||
|
|
channel. Processes typically interpret this as a closed stdin descriptor.
|
||
|
|
.SH RETURN VALUE
|
||
|
|
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 is not really a failure per se.
|
||
|
|
.SH ERRORS
|
||
|
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR libssh2_channel_wait_eof(3)
|
||
|
|
.BR libssh2_channel_eof(3)
|