aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authortmilburn <thomas2@instantsolve.net>2019-03-07 20:23:54 +0000
committerDaniel Stenberg <daniel@haxx.se>2019-04-13 11:18:55 +0200
commitc3e38a4250d5f21a9189c3fdbbe45fbb71242184 (patch)
treed63321693aeacf22bd24847ceef8d08785f6dfec /docs
parentd715d2ac89abc0fc98ccb220c7f7cc148e747144 (diff)
CURLOPT_ADDRESS_SCOPE: fix range check and more
Commit 9081014 fixed most of the confusing issues between scope id and scope however 844896d added bad limits checking assuming that the scope is being set and not the scope id. I have fixed the documentation so it all refers to scope ids. In addition Curl_if2ip refered to the scope id as remote_scope_id which is incorrect, so I renamed it to local_scope_id. Adjusted-by: Daniel Stenberg Closes #3655 Closes #3765 Fixes #3713
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/opts/CURLOPT_ADDRESS_SCOPE.316
1 files changed, 7 insertions, 9 deletions
diff --git a/docs/libcurl/opts/CURLOPT_ADDRESS_SCOPE.3 b/docs/libcurl/opts/CURLOPT_ADDRESS_SCOPE.3
index 4ce6db9b1..13ca667df 100644
--- a/docs/libcurl/opts/CURLOPT_ADDRESS_SCOPE.3
+++ b/docs/libcurl/opts/CURLOPT_ADDRESS_SCOPE.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2014, 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -22,14 +22,13 @@
.\"
.TH CURLOPT_ADDRESS_SCOPE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
.SH NAME
-CURLOPT_ADDRESS_SCOPE \- set scope for local IPv6 addresses
+CURLOPT_ADDRESS_SCOPE \- set scope id for IPv6 addresses
.SH SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ADDRESS_SCOPE, long scope);
.SH DESCRIPTION
-Pass a long specifying the scope_id value to use when connecting to IPv6
-link-local or site-local addresses.
+Pass a long specifying the scope id value to use when connecting to IPv6 addresses.
.SH DEFAULT
0
.SH PROTOCOLS
@@ -39,12 +38,10 @@ All, when using IPv6
CURL *curl = curl_easy_init();
if(curl) {
CURLcode ret;
+ long my_scope_id;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
- /* 0x2 link-local
- 0x5 site-local
- 0x8 organization-local
- 0xe global ... */
- curl_easy_setopt(curl, CURLOPT_ADDRESS_SCOPE, 0xEL);
+ my_scope_id = if_nametoindex("eth0");
+ curl_easy_setopt(curl, CURLOPT_ADDRESS_SCOPE, my_scope_id);
ret = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
@@ -53,5 +50,6 @@ if(curl) {
Added in 7.19.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a negative value.
.SH "SEE ALSO"
.BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "