1libssh2_channel_close(3)        libssh2 manual        libssh2_channel_close(3)
2
3
4

NAME

6       libssh2_channel_close - close a channel
7

SYNOPSIS

9       #include <libssh2.h>
10
11       int libssh2_channel_close(LIBSSH2_CHANNEL *channel);
12
13

DESCRIPTION

15       channel - active channel stream to set closed status on.
16
17       Close  an  active  data  channel.  In  practice  this  means sending an
18       SSH_MSG_CLOSE packet to the remote host  which  serves  as  instruction
19       that no further data will be sent to it. The remote host may still send
20       data back until it sends its own close message in response. To wait for
21       the  remote  end  to  close its connection as well, follow this command
22       with libssh2_channel_wait_closed(3)
23
24

RETURN VALUE

26       Return  0  on  success  or  negative  on  failure.   It  returns   LIB‐
27       SSH2_ERROR_EAGAIN   when   it   would   otherwise   block.  While  LIB‐
28       SSH2_ERROR_EAGAIN is a negative number, it isn't really a  failure  per
29       se.
30
31

ERRORS

33       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
34
35

SEE ALSO

37       libssh2_channel_open_ex(3)
38
39
40
41libssh2 0.15                      1 Jun 2007          libssh2_channel_close(3)
Impressum