mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-22 00:45:51 +03:00
f6aa31f48f
- All files have prominent copyright and SPDX identifier - If not embedded in the file, in the .reuse/dep5 file - All used licenses are in LICENSES/ (not shipped in tarballs) - A new REUSE CI job verify that all files are OK Assisted-by: Viktor Szakats Closes #1084
26 lines
856 B
Groff
26 lines
856 B
Groff
.\" Copyright (C) The libssh2 project and its contributors.
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
|
.TH libssh2_channel_wait_closed 3 "29 Nov 2007" "libssh2 0.19" "libssh2"
|
|
.SH NAME
|
|
libssh2_channel_wait_closed - wait for the remote to close the channel
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Enter a temporary blocking state until the remote host closes the named
|
|
channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to
|
|
examine the exit status.
|
|
|
|
.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 SEE ALSO
|
|
.BR libssh2_channel_send_eof(3)
|
|
.BR libssh2_channel_eof(3)
|
|
.BR libssh2_channel_wait_eof(3)
|