~ubuntu-branches/ubuntu/intrepid/curl/intrepid

« back to all changes in this revision

Viewing changes to docs/libcurl/libcurl-multi.3

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-10-30 10:56:48 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20061030105648-uo8q8w9xklb40b4k
Tags: 7.15.5-1ubuntu1
* Merge from debian unstable. Remaining Ubuntu changes:
  - debian/control: Drop libdb4.2 build dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" You can view this file with:
2
 
.\" nroff -man [file]
3
 
.\" $Id: libcurl-multi.3,v 1.12 2004/07/17 08:24:22 bagder Exp $
 
1
.\" **************************************************************************
 
2
.\" *                                  _   _ ____  _
 
3
.\" *  Project                     ___| | | |  _ \| |
 
4
.\" *                             / __| | | | |_) | |
 
5
.\" *                            | (__| |_| |  _ <| |___
 
6
.\" *                             \___|\___/|_| \_\_____|
 
7
.\" *
 
8
.\" * Copyright (C) 1998 - 2006, Daniel Stenberg, <daniel@haxx.se>, et al.
 
9
.\" *
 
10
.\" * This software is licensed as described in the file COPYING, which
 
11
.\" * you should have received as part of this distribution. The terms
 
12
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
 
13
.\" *
 
14
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
 
15
.\" * copies of the Software, and permit persons to whom the Software is
 
16
.\" * furnished to do so, under the terms of the COPYING file.
 
17
.\" *
 
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 
19
.\" * KIND, either express or implied.
 
20
.\" *
 
21
.\" * $Id: libcurl-multi.3,v 1.13 2006-06-26 06:43:45 bagder Exp $
 
22
.\" **************************************************************************
4
23
.\"
5
24
.TH libcurl-multi 3 "13 Oct 2001" "libcurl 7.10.1" "libcurl multi interface"
6
25
.SH NAME
14
33
 
15
34
All functions in the multi interface are prefixed with curl_multi.
16
35
.SH "OBJECTIVES"
17
 
The multi interface introduces several new abilities that the easy interface
18
 
refuses to offer. They are mainly:
 
36
The multi interface offers several abilities that the easy interface doesn't.
 
37
They are mainly:
19
38
 
20
39
1. Enable a "pull" interface. The application that uses libcurl decides where
21
40
and when to ask libcurl to get/send data.
23
42
2. Enable multiple simultaneous transfers in the same thread without making it
24
43
complicated for the application.
25
44
 
26
 
3. Enable the application to select() on its own file descriptors and curl's
27
 
file descriptors simultaneous easily.
 
45
3. Enable the application to wait for action on its own file descriptors and
 
46
curl's file descriptors simultaneous easily.
28
47
.SH "ONE MULTI HANDLE MANY EASY HANDLES"
29
48
To use the multi interface, you must first create a 'multi handle' with
30
49
\fIcurl_multi_init(3)\fP. This handle is then used as input to all further