forked from curl/curl
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
options: API for meta-data about easy options
const struct curl_easyoption *curl_easy_option_by_name(const char *name); const struct curl_easyoption *curl_easy_option_by_id (CURLoption id); const struct curl_easyoption * curl_easy_option_next(const struct curl_easyoption *prev); The purpose is to provide detailed enough information to allow for example libcurl bindings to get option information at run-time about what easy options that exist and what arguments they expect. Assisted-by: Jeroen Ooms Closes curl#5365
- Loading branch information
Showing
22 changed files
with
1,019 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| .\" ************************************************************************** | ||
| .\" * _ _ ____ _ | ||
| .\" * Project ___| | | | _ \| | | ||
| .\" * / __| | | | |_) | | | ||
| .\" * | (__| |_| | _ <| |___ | ||
| .\" * \___|\___/|_| \_\_____| | ||
| .\" * | ||
| .\" * Copyright (C) 1998 - 2020, 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 | ||
| .\" * are also available at https://curl.haxx.se/docs/copyright.html. | ||
| .\" * | ||
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
| .\" * copies of the Software, and permit persons to whom the Software is | ||
| .\" * furnished to do so, under the terms of the COPYING file. | ||
| .\" * | ||
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
| .\" * KIND, either express or implied. | ||
| .\" * | ||
| .\" ************************************************************************** | ||
| .TH curl_easy_option_by_id 3 "15 May 2020" "libcurl 7.71.0" "libcurl Manual" | ||
| .SH NAME | ||
| curl_easy_option_by_id - find an easy setopt option by id | ||
| .SH SYNOPSIS | ||
| .nf | ||
| #include <curl/curl.h> | ||
|
|
||
| const struct curl_easyoption *curl_easy_option_by_id(CURLoption id); | ||
| .fi | ||
| .SH DESCRIPTION | ||
| Given a CURLoption \fBid\fP, this function returns a pointer to the | ||
| curl_easyoption struct, holding information about the | ||
| \fIcurl_easy_setopt(3)\fP option using that id. The option id is the CURLOPT_ | ||
| prefix ones provided in the standard curl/curl.h header file. This function | ||
| will return the non-aliases version for the cases where there is an alias | ||
| function as well. | ||
|
|
||
| If libcurl has no option with the given id, this function returns NULL. | ||
| .SH AVAILABILITY | ||
| This function was added in libcurl 7.71.0 | ||
| .SH RETURN VALUE | ||
| A pointer to the curl_easyoption struct for the option or NULL. | ||
| .SH "SEE ALSO" | ||
| .BR curl_easy_option_by_name "(3)," curl_easy_option_next "(3)," | ||
| .BR curl_easy_setopt "(3)," |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| .\" ************************************************************************** | ||
| .\" * _ _ ____ _ | ||
| .\" * Project ___| | | | _ \| | | ||
| .\" * / __| | | | |_) | | | ||
| .\" * | (__| |_| | _ <| |___ | ||
| .\" * \___|\___/|_| \_\_____| | ||
| .\" * | ||
| .\" * Copyright (C) 1998 - 2020, 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 | ||
| .\" * are also available at https://curl.haxx.se/docs/copyright.html. | ||
| .\" * | ||
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
| .\" * copies of the Software, and permit persons to whom the Software is | ||
| .\" * furnished to do so, under the terms of the COPYING file. | ||
| .\" * | ||
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
| .\" * KIND, either express or implied. | ||
| .\" * | ||
| .\" ************************************************************************** | ||
| .TH curl_easy_option_by_name 3 "15 May 2020" "libcurl 7.71.0" "libcurl Manual" | ||
| .SH NAME | ||
| curl_easy_option_by_name - find an easy setopt option by name | ||
| .SH SYNOPSIS | ||
| .nf | ||
| #include <curl/curl.h> | ||
|
|
||
| const struct curl_easyoption *curl_easy_option_by_name(const char *name); | ||
| .fi | ||
| .SH DESCRIPTION | ||
| Given a \fBname\fP, this function returns a pointer to the curl_easyoption | ||
| struct, holding information about the \fIcurl_easy_setopt(3)\fP option using | ||
| that name. The name should be specified without the "CURLOPT_" prefix and the | ||
| name comparison is made case insensitive. | ||
|
|
||
| If libcurl has no option with the given name, this function returns NULL. | ||
| .SH AVAILABILITY | ||
| This function was added in libcurl 7.71.0 | ||
| .SH RETURN VALUE | ||
| A pointer to the curl_easyoption struct for the option or NULL. | ||
| .SH "SEE ALSO" | ||
| .BR curl_easy_option_next "(3)," curl_easy_option_by_id "(3)," | ||
| .BR curl_easy_setopt "(3)," |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| .\" ************************************************************************** | ||
| .\" * _ _ ____ _ | ||
| .\" * Project ___| | | | _ \| | | ||
| .\" * / __| | | | |_) | | | ||
| .\" * | (__| |_| | _ <| |___ | ||
| .\" * \___|\___/|_| \_\_____| | ||
| .\" * | ||
| .\" * Copyright (C) 1998 - 2020, 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 | ||
| .\" * are also available at https://curl.haxx.se/docs/copyright.html. | ||
| .\" * | ||
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
| .\" * copies of the Software, and permit persons to whom the Software is | ||
| .\" * furnished to do so, under the terms of the COPYING file. | ||
| .\" * | ||
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
| .\" * KIND, either express or implied. | ||
| .\" * | ||
| .\" ************************************************************************** | ||
| .TH curl_easy_option_next 3 "15 May 2020" "libcurl 7.71.0" "libcurl Manual" | ||
| .SH NAME | ||
| curl_easy_option_next - iterate over easy setopt options | ||
| .SH SYNOPSIS | ||
| .nf | ||
| #include <curl/curl.h> | ||
|
|
||
| typedef enum { | ||
| CURLOT_LONG, /* long (a range of values) */ | ||
| CURLOT_VALUES, /* (a defined set or bitmask) */ | ||
| CURLOT_OFF_T, /* curl_off_t (a range of values) */ | ||
| CURLOT_OBJECT, /* pointer (void *) */ | ||
| CURLOT_STRING, /* (char * to zero terminated buffer) */ | ||
| CURLOT_SLIST, /* (struct curl_slist *) */ | ||
| CURLOT_CBPTR, /* (void * passed as-is to a callback) */ | ||
| CURLOT_BLOB, /* blob (struct curl_blob *) */ | ||
| CURLOT_FUNCTION /* function pointer */ | ||
| } curl_easytype; | ||
|
|
||
| /* The CURLOPTTYPE_* id ranges can still be used to figure out what type/size | ||
| to use for curl_easy_setopt() for the given id */ | ||
| struct curl_easyoption { | ||
| const char *name; | ||
| CURLoption id; | ||
| curl_easytype type; | ||
| unsigned int flags; | ||
| }; | ||
|
|
||
| const struct curl_easyoption * | ||
| curl_easy_option_next(const struct curl_easyoption *prev); | ||
| .fi | ||
| .SH DESCRIPTION | ||
| This function returns a pointer to the first or the next curl_easyoption | ||
| struct, providing an ability to iterate over all known options for | ||
| \fIcurl_easy_setopt(3)\fP in this instance of libcurl. | ||
|
|
||
| Pass a \fBNULL\fP argument as \fBprev\fP to get the first option returned, or | ||
| pass in the current option to get the next one returned. If there is no more | ||
| option to return, \fIcurl_easy_option_next(3)\fP returns NULL. | ||
|
|
||
| The options returned by this functions are the ones known to this libcurl and | ||
| information about what argument type they want. | ||
|
|
||
| If the \fBCURLOT_FLAG_ALIAS\fP bit is set in the flags field, it means the | ||
| name is provided for backwards compatibility as an alias. | ||
| .SH AVAILABILITY | ||
| This function was added in libcurl 7.71.0 | ||
| .SH RETURN VALUE | ||
| A pointer to the curl_easyoption struct for the next option or NULL if no more | ||
| options. | ||
| .SH "SEE ALSO" | ||
| .BR curl_easy_option_by_name "(3)," curl_easy_option_by_id "(3)," | ||
| .BR curl_easy_setopt "(3)," |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.