← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gnutls28/quantal

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_transport_set_pull_timeout_function.3

  • Committer: Package Import Robot
  • Author(s): Andreas Metzler
  • Date: 2011-12-17 11:41:19 UTC
  • mfrom: (10.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20111217114119-sp3ixi00tjajm52g
Tags: 3.0.9-2
* [20_test-select.diff] Do not run gnulib test-select test anymore. The
  test fails on kfreebsd-i386, the gnutls library does not use select().
* [30_correctly-set-the-odd-bits.patch] Post release fix from GIT head.
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/gnutls_transport_set_pull_timeout_function.3
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
 
2
.TH "gnutls_transport_set_pull_timeout_function" 3 "3.0.9" "gnutls" "gnutls"
 
3
.SH NAME
 
4
gnutls_transport_set_pull_timeout_function \- API function
 
5
.SH SYNOPSIS
 
6
.B #include <gnutls/gnutls.h>
 
7
.sp
 
8
.BI "void gnutls_transport_set_pull_timeout_function(gnutls_session_t " session ", gnutls_pull_timeout_func " func ");"
 
9
.SH ARGUMENTS
 
10
.IP "gnutls_session_t session" 12
 
11
is a \fBgnutls_session_t\fP structure.
 
12
.IP "gnutls_pull_timeout_func func" 12
 
13
a callback function
 
14
.SH "DESCRIPTION"
 
15
This is the function where you set a function for gnutls to know
 
16
whether data are ready to be received. It should wait for data a
 
17
given time frame in milliseconds. The callback should return 0 on 
 
18
timeout, a positive number if data can be received, and \-1 on error.
 
19
You'll need to override this function if \fBselect()\fP is not suitable
 
20
for the provided transport calls. 
 
21
The callback function is used in DTLS only.
 
22
 
 
23
 \fIgnutls_pull_timeout_func\fPis of the form,
 
24
ssize_t (*gnutls_pull_timeout_func)(gnutls_transport_ptr_t, unsigned int ms);
 
25
.SH "SINCE"
 
26
3.0.0
 
27
.SH "REPORTING BUGS"
 
28
Report bugs to <bug-gnutls@gnu.org>.
 
29
GnuTLS home page: http://www.gnu.org/software/gnutls/
 
30
General help using GNU software: http://www.gnu.org/gethelp/
 
31
.SH COPYRIGHT
 
32
Copyright \(co 2011 Free Software Foundation.
 
33
.br
 
34
Copying and distribution of this file, with or without modification,
 
35
are permitted in any medium without royalty provided the copyright
 
36
notice and this notice are preserved.
 
37
.SH "SEE ALSO"
 
38
The full documentation for
 
39
.B gnutls
 
40
is maintained as a Texinfo manual.  If the
 
41
.B info
 
42
and
 
43
.B gnutls
 
44
programs are properly installed at your site, the command
 
45
.IP
 
46
.B info gnutls
 
47
.PP
 
48
should give you access to the complete manual.