libssh2_channel_wait_closed.3 754 B

12345678910111213141516171819202122
  1. .TH libssh2_channel_wait_closed 3 "29 Nov 2007" "libssh2 0.19" "libssh2 manual"
  2. .SH NAME
  3. libssh2_channel_wait_closed - wait for the remote to close the channel
  4. .SH SYNOPSIS
  5. #include <libssh2.h>
  6. int
  7. libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel);
  8. .SH DESCRIPTION
  9. Enter a temporary blocking state until the remote host closes the named
  10. channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to
  11. examine the exit status.
  12. .SH RETURN VALUE
  13. Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
  14. when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
  15. number, it isn't really a failure per se.
  16. .SH SEE ALSO
  17. .BR libssh2_channel_send_eof(3)
  18. .BR libssh2_channel_eof(3)
  19. .BR libssh2_channel_wait_eof(3)