mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-19 02:24:04 +03:00
a3ffc4221d
- `- ` -> `- ` - `. ` -> `. ` - `\- ` -> `- ` - `-1` -> `\-1` - fold long lines along the way This makes the minus sign come out as a Unicode minus sign (0x2212), and title separator dashes as Unicode hyphen (0x2010), with `groff -Tutf8` v1.23.0. Ref: https://lwn.net/Articles/947941/ Closes #1210
30 lines
1.1 KiB
Groff
30 lines
1.1 KiB
Groff
.\" Copyright (C) The libssh2 project and its contributors.
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
|
.TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
|
.SH NAME
|
|
libssh2_channel_close - close a channel
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_close(LIBSSH2_CHANNEL *channel);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fIchannel\fP - active channel stream to set closed status on.
|
|
|
|
Close an active data channel. In practice this means sending an SSH_MSG_CLOSE
|
|
packet to the remote host which serves as instruction that no further data
|
|
will be sent to it. The remote host may still send data back until it sends
|
|
its own close message in response. To wait for the remote end to close its
|
|
connection as well, follow this command with
|
|
.BR libssh2_channel_wait_closed(3)
|
|
.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_open_ex(3)
|