curl/lib
Daniel Stenberg 01f05d0c75 return code cleanup: build, init and run-time errors
Stop the abuse of CURLE_FAILED_INIT as return code for things not being
init related by introducing two new return codes:

CURLE_NOT_BUILT_IN and CURLE_UNKNOWN_OPTION

CURLE_NOT_BUILT_IN replaces return code 4 that has been obsoleted for
several years. It is used for returning error when something is
attempted to be used but the feature/option was not enabled or
explictitly disabled at build-time. Getting this error mostly means that
libcurl needs to be rebuilt.

CURLE_FAILED_INIT is now saved and used strictly for init
failures. Getting this problem means something went seriously wrong,
like a resource shortage or similar.

CURLE_UNKNOWN_OPTION is the option formerly known as
CURLE_UNKNOWN_TELNET_OPTION (and the old name is still present,
separately defined to be removed in a very distant future). This error
code is meant to be used to return when an option is given to libcurl
that isn't known. This problem would mostly indicate a problem in the
program that uses libcurl.
2011-04-05 15:14:02 +02:00
..
.gitignore
amigaos.c
amigaos.h
arpa_telnet.h
axtls.c
axtls.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
base64.c
CMakeLists.txt
config-amigaos.h
config-dos.h
config-mac.h
config-os400.h
config-riscos.h
config-symbian.h
config-tpf.h
config-vms.h
config-vxworks.h
config-win32.h
config-win32ce.h
connect.c
connect.h
content_encoding.c
content_encoding.h
cookie.c
cookie.h
curl_addrinfo.c
curl_addrinfo.h
curl_base64.h
curl_config.h.cmake
curl_fnmatch.c
curl_fnmatch.h
curl_gethostname.c
curl_gethostname.h
curl_hmac.h
curl_ldap.h
curl_md4.h
curl_md5.h
curl_memory.h
curl_memrchr.c
curl_memrchr.h
curl_rand.c
curl_rand.h
curl_rtmp.c
curl_rtmp.h
curl_sspi.c
curl_sspi.h
curl_threads.c
curl_threads.h
curlx.h
cyassl.c
cyassl.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
dict.c
dict.h
easy.c
easyif.h
escape.c
escape.h
file.c
file.h
fileinfo.c
fileinfo.h
firefox-db2pem.sh
formdata.c
formdata.h
ftp.c return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
ftp.h
ftplistparser.c
ftplistparser.h
getenv.c
getinfo.c
getinfo.h
gopher.c
gopher.h
gtls.c
gtls.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
hash.c
hash.h
hmac.c
hostares.c
hostasyn.c
hostip4.c
hostip6.c
hostip.c
hostip.h
hostsyn.c
hostthre.c
http_chunks.c
http_chunks.h
http_digest.c
http_digest.h
http_negotiate_sspi.c
http_negotiate.c
http_negotiate.h
http_ntlm.c
http_ntlm.h
http_proxy.c http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
http_proxy.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
http.c http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
http.h http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
idn_win32.c
if2ip.c
if2ip.h
imap.c http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
imap.h
inet_ntop.c
inet_ntop.h
inet_pton.c
inet_pton.h
krb4.c
krb4.h
krb5.c
ldap.c
libcurl.def
libcurl.imp
libcurl.plist
libcurl.rc
llist.c
llist.h
Makefile.am
makefile.amiga
Makefile.b32
makefile.dj
Makefile.inc http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
Makefile.m32
Makefile.netware
Makefile.vc6 http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
Makefile.vxworks
Makefile.Watcom
md4.c
md5.c
memdebug.c
memdebug.h
mk-ca-bundle.pl
mk-ca-bundle.vbs
mprintf.c
msvcproj.foot
msvcproj.head
multi.c
multiif.h
netrc.c
netrc.h
nonblock.c
nonblock.h
nss.c
nssg.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
nwlib.c
nwos.c
openldap.c http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
parsedate.c
parsedate.h
pingpong.c
pingpong.h
polarssl.c
polarssl.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
pop3.c [pop3 starttls] PASS command was not sent after upgrade to TLS. 2011-04-05 13:38:31 +02:00
pop3.h
progress.c
progress.h
qssl.c
qssl.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
rawstr.c
rawstr.h
README.ares
README.curl_off_t
README.curlx
README.encoding
README.hostip
README.httpauth
README.memoryleak
README.multi_socket
README.pingpong
README.pipelining
rtsp.c
rtsp.h
security.c
select.c
select.h
sendf.c
sendf.h
setup_once.h
setup-os400.h
setup.h
share.c
share.h
slist.c
slist.h
smtp.c http-proxy: move proxy code to http_proxy.c 2011-04-04 19:38:00 +02:00
smtp.h
sockaddr.h
socks_gssapi.c
socks_sspi.c
socks.c
socks.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
speedcheck.c
speedcheck.h
splay.c
splay.h
ssh.c
ssh.h
sslgen.c
sslgen.h return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
ssluse.c
ssluse.h
strdup.c
strdup.h
strequal.c
strequal.h
strerror.c return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
strerror.h
strtok.c
strtok.h
strtoofft.c
strtoofft.h
telnet.c
telnet.h
tftp.c
tftp.h
timeval.c
timeval.h
transfer.c
transfer.h
url.c return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
url.h
urldata.h
vc6libcurl.dsw
vc8proj.foot
vc8proj.head
version.c
warnless.c
warnless.h
wildcard.c
wildcard.h

HTTP Pipelining with libcurl
============================

Background

Since pipelining implies that one or more requests are sent to a server before
the previous response(s) have been received, we only support it for multi
interface use.

Considerations

When using the multi interface, you create one easy handle for each transfer.
Bascially any number of handles can be created, added and used with the multi
interface - simultaneously. It is an interface designed to allow many
simultaneous transfers while still using a single thread. Pipelining does not
change any of these details.

API

We've added a new option to curl_multi_setopt() called CURLMOPT_PIPELINING
that enables "attempted pipelining" and then all easy handles used on that
handle will attempt to use an existing pipeline.

Details

- A pipeline is only created if a previous connection exists to the same IP
  address that the new request is being made to use.

- Pipelines are only supported for HTTP(S) as no other currently supported
  protocol has features resemembling this, but we still name this feature
  plain 'pipelining' to possibly one day support it for other protocols as
  well.

- HTTP Pipelining is for GET and HEAD requests only.

- When a pipeline is in use, we must take precautions so that when used easy
  handles (i.e those who still wait for a response) are removed from the multi
  handle, we must deal with the outstanding response nicely.

- Explicitly asking for pipelining handle X and handle Y won't be supported.
  It isn't easy for an app to do this association. The lib should probably
  still resolve the second one properly to make sure that they actually _can_
  be considered for pipelining. Also, asking for explicit pipelining on handle
  X may be tricky when handle X get a closed connection.

- We need options to control max pipeline length, and probably how to behave
  if we reach that limit. As was discussed on the list, it can probably be
  made very complicated, so perhaps we can think of a way to pass all
  variables involved to a callback and let the application decide how to act
  in specific situations. Either way, these fancy options are only interesting
  to work on when everything is working and we have working apps to test with.