libssh2_channel_receive_window_adjust2.3 1.1 KB

123456789101112131415161718192021222324252627
  1. .TH libssh2_channel_receive_window_adjust2 3 "26 Mar 2009" "libssh2 1.1" "libssh2 manual"
  2. .SH NAME
  3. libssh2_channel_receive_window_adjust2 - adjust the channel window
  4. .SH SYNOPSIS
  5. #include <libssh2.h>
  6. int
  7. libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel,
  8. unsigned long adjustment,
  9. unsigned char force,
  10. unsigned int *window);
  11. .SH DESCRIPTION
  12. Adjust the receive window for a channel by adjustment bytes. If the amount to
  13. be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the
  14. adjustment amount will be queued for a later packet.
  15. This function stores the new size of the receive window (as understood by
  16. remote end) in the variable 'window' points to.
  17. .SH RETURN VALUE
  18. Return 0 on success and a negative value on error. If used in non-blocking
  19. mode it will return LIBSSH2_ERROR_EAGAIN when it would otherwise block.
  20. .SH ERRORS
  21. .SH AVAILABILITY
  22. Added in libssh2 1.1 since the previous API has deficiencies.
  23. .SH SEE ALSO
  24. .BR libssh2_channel_window_read_ex(3)