Skip to content

Commit

Permalink
Document more new cURL constants
Browse files Browse the repository at this point in the history
  • Loading branch information
@ekinhbayar
ekinhbayar committed Nov 6, 2022
1 parent 80c10f3 commit 90b94c2
Show file tree
Hide file tree
Showing 2 changed files with 197 additions and 0 deletions.
99 changes: 99 additions & 0 deletions reference/curl/constants.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,17 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-upload-buffersize">
<term>
<constant>CURLOPT_UPLOAD_BUFFERSIZE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.62.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-post">
<term>
<constant>CURLOPT_POST</constant>
Expand Down Expand Up @@ -1058,6 +1069,39 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-maxage-conn">
<term>
<constant>CURLOPT_MAXAGE_CONN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.65.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-maxfilesize-large">
<term>
<constant>CURLOPT_MAXFILESIZE_LARGE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.11.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-maxlifetime-conn">
<term>
<constant>CURLOPT_MAXLIFETIME_CONN</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.80.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-maxredirs">
<term>
<constant>CURLOPT_MAXREDIRS</constant>
Expand Down Expand Up @@ -1212,6 +1256,17 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-ssl-ec-curves">
<term>
<constant>CURLOPT_SSL_EC_CURVES</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.73.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-binarytransfer">
<term>
<constant>CURLOPT_BINARYTRANSFER</constant>
Expand Down Expand Up @@ -1575,6 +1630,28 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-mail-rcpt-allowfails">
<term>
<constant>CURLOPT_MAIL_RCPT_ALLLOWFAILS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.69.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-upkeep-interval-ms">
<term>
<constant>CURLOPT_UPKEEP_INTERVAL_MS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.62.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-max-recv-speed-large">
<term>
<constant>CURLOPT_MAX_RECV_SPEED_LARGE</constant>
Expand Down Expand Up @@ -3441,6 +3518,17 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-ssh-host-public-key-md5">
<term>
<constant>CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.80.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-ssh-private-keyfile">
<term>
<constant>CURLOPT_SSH_PRIVATE_KEYFILE</constant>
Expand Down Expand Up @@ -3507,6 +3595,17 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-sasl-ir">
<term>
<constant>CURLOPT_SASL_AUTHZID</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.2.0 and cURL 7.66.0
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.curlopt-sasl-ir">
<term>
<constant>CURLOPT_SASL_IR</constant>
Expand Down
98 changes: 98 additions & 0 deletions reference/curl/functions/curl-setopt.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,17 @@
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_SASL_AUTHZID</constant></entry>
<entry valign="top">
The null-terminated authorization identity (authzid) for the transfer. Only applicable to the PLAIN SASL
authentication mechanism where it is optional. When not specified, only the authentication identity
(authcid) as specified by the username will be sent to the server, along with the password.
The server will derive the authzid from the authcid when not provided, which it will then use internally.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_SASL_IR</constant></entry>
<entry valign="top">
Expand Down Expand Up @@ -589,6 +600,16 @@
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_UPLOAD_BUFFERSIZE</constant></entry>
<entry valign="top">
Preferred buffer size in bytes for the cURL upload buffer.
The upload buffer size by default is 64 kilobytes. The maximum buffer size allowed to be set is 2 megabytes.
The minimum buffer size allowed to be set is 16 kilobytes.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_VERBOSE</constant></entry>
<entry valign="top">
Expand Down Expand Up @@ -835,6 +856,37 @@
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_MAXAGE_CONN</constant></entry>
<entry valign="top">
The maximum idle time allowed for an existing connection to be considered for reuse.
Default maximum age is set to 118 seconds.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_MAXFILESIZE_LARGE</constant></entry>
<entry valign="top">
The maximum file size in bytes allowed to download. If the file requested is found larger than this value,
the transfer will not start and <constant>CURLE_FILESIZE_EXCEEDED</constant> will be returned.
The file size is not always known prior to download, and for such files this option has no effect even if
the file transfer ends up being larger than this given limit.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_MAXLIFETIME_CONN</constant></entry>
<entry valign="top">
The maximum time in seconds, since the creation of the connection, that is allowed for an existing
connection to have for it to be considered for reuse. If a connection is found in the cache that is older
than this value, it will instead be closed once any in-progress transfers are complete.
Default is 0 seconds, meaning the option is disabled and all connections are eligible for reuse.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_MAXCONNECTS</constant></entry>
<entry valign="top">
Expand Down Expand Up @@ -1232,6 +1284,32 @@
Added in cURL 7.59.0. Available since PHP 7.3.0.
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_MAIL_RCPT_ALLLOWFAILS</constant></entry>
<entry valign="top">
Allow RCPT TO command to fail for some recipients.
</entry>
<entry valign="top">
When sending data to multiple recipients, by default cURL will abort SMTP conversation if at least one of
the recipients causes RCPT TO command to return an error. This option tells cURL to ignore errors and
proceed with the remaining valid recipients. If all recipients trigger RCPT TO failures and this flag is
set, cURL will abort the SMTP conversation and return the error received from the last RCPT TO command.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_UPKEEP_INTERVAL_MS</constant></entry>
<entry valign="top">
Some protocols have "connection upkeep" mechanisms. These mechanisms usually send some traffic
on existing connections in order to keep them alive. This option defines the connection upkeep interval.
Currently, the only protocol with a connection upkeep mechanism is HTTP/2. When the connection upkeep
interval is exceeded, an HTTP/2 PING frame is sent on the connection.
Default is 60 seconds.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_MAX_RECV_SPEED_LARGE</constant></entry>
<entry valign="top">
Expand Down Expand Up @@ -1876,6 +1954,15 @@
Added in cURL 7.17.1.
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256</constant></entry>
<entry valign="top">
Base64-encoded SHA256 hash of the remote host's public key.
The transfer will fail if the given hash does not match the hash the remote host provides.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_SSH_PUBLIC_KEYFILE</constant></entry>
<entry valign="top">
Expand Down Expand Up @@ -1910,6 +1997,17 @@
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_SSL_EC_CURVES</constant></entry>
<entry valign="top">
A colon delimited list of elliptic curve algorithms. For example,
<literal>X25519:P-521</literal> is a valid list of two elliptic curves.
This option defines the client's key exchange algorithms in the SSL handshake,
if the SSL backend cURL is built to use supports it.
</entry>
<entry valign="top">
</entry>
</row>
<row>
<entry valign="top"><constant>CURLOPT_SSLCERT</constant></entry>
<entry valign="top">
Expand Down

0 comments on commit 90b94c2

Please sign in to comment.