libssh2/share/man/man3/libssh2_session_callback_set.3

   1 .\" $Id: libssh2_session_callback_set.3,v 1.1 2007/06/14 15:26:58 jehousley Exp $
   2 .\"
   3 .TH libssh2_session_callback_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_session_callback_set - set a callback function
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 void *
  10 libssh2_session_callback_set(LIBSSH2_SESSION *session, int cbtype, void *callback);
  11
  12 .SH DESCRIPTION
  13 \fIsession\fP - Session instance as returned by
  14 .BR libssh2_session_init(3)
  15
  16 \fIcbtype\fP - Callback type. One of the types listed in Callback Types.
  17
  18 \fIcallback\fP - Pointer to custom callback function. The prototype for
  19 this function must match the associated callback declaration macro.
  20
  21 Sets a custom callback handler for a previously initialized session
  22 object. Callbacks are triggered by the receipt of special packets at
  23 the Transport layer. To disable a callback, set it to NULL.
  24
  25 .SH RETURN VALUE
  26 Pointer to previous callback handler. Returns NULL if no
  27 prior callback handler was set.
  28
  29 .SH SEE ALSO
  30 .BR libssh2_session_init(3)