libssh2_channel_wait_closed(3)

libssh2_channel_wait_closed3

Wait for the remote to close the channel

Usage

#include <libssh2.h>
int
libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel);

Overview

Enter a temporary blocking state until the remote host closes the named channel. Typically sent after libssh2_channel_close(3) in order to examine the exit status.

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.

Releases

9 releases since Debian 6.0 (Squeeze); the text changed 2 times.

  1. 6.0
  2. 7–12
  3. 13–Arch

From libssh2 1.11.1-7 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.