forked fromglynos/cpp-netlib
- Notifications
You must be signed in to change notification settings - Fork425
Document client options#613
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
2f21623 Add doxygen documentation for client options
deanberris1e7c0e7 Use Doxygen-generated Documentation
deanberris7c6c708 Update generated HTTP client docs
deanberris6608f74 Default true to always_verify_peer
deanberrisd9ed6d9 Update generated docs for HTTP client
deanberrisFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
26 changes: 25 additions & 1 deletionboost/network/protocol/http/client/options.hpp
This file contains hidden or 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 |
|---|---|---|
| @@ -21,6 +21,7 @@ class client_options { | ||
| public: | ||
| typedef typename string<Tag>::type string_type; | ||
| /// Set all the options to default. | ||
| client_options() | ||
| : cache_resolved_(false), | ||
| follow_redirects_(false), | ||
| @@ -32,7 +33,7 @@ class client_options { | ||
| openssl_sni_hostname_(), | ||
| openssl_options_(0), | ||
| io_service_(), | ||
| always_verify_peer_(true), | ||
| timeout_(0) {} | ||
| client_options(client_options const& other) | ||
| @@ -70,61 +71,84 @@ class client_options { | ||
| swap(timeout_, other.timeout_); | ||
| } | ||
| /// Specify whether the client should cache resolved endpoints. | ||
| /// | ||
| /// Default: false. | ||
| client_options& cache_resolved(bool v) { | ||
| cache_resolved_ = v; | ||
| return *this; | ||
| } | ||
| /// Specify whether the client should follow redirects. | ||
| /// | ||
| /// Default: false. | ||
| /// \deprecated Not supported by asynchronous client implementation. | ||
| client_options& follow_redirects(bool v) { | ||
| follow_redirects_ = v; | ||
| return *this; | ||
| } | ||
| /// Set the filename of the certificate to load for the SSL connection for | ||
| /// verification. | ||
| client_options& openssl_certificate(string_type const& v) { | ||
| openssl_certificate_ = v; | ||
| return *this; | ||
| } | ||
| /// Set the directory for which the certificate authority files are located. | ||
| client_options& openssl_verify_path(string_type const& v) { | ||
| openssl_verify_path_ = v; | ||
| return *this; | ||
| } | ||
| /// Set the filename of the certificate to use for client-side SSL session | ||
| /// establishment. | ||
| client_options& openssl_certificate_file(string_type const& v) { | ||
| openssl_certificate_file_ = v; | ||
| return *this; | ||
| } | ||
| /// Set the filename of the private key to use for client-side SSL session | ||
| /// establishment. | ||
| client_options& openssl_private_key_file(string_type const& v) { | ||
| openssl_private_key_file_ = v; | ||
| return *this; | ||
| } | ||
| /// Set the ciphers to support for SSL negotiation. | ||
| client_options& openssl_ciphers(string_type const& v) { | ||
| openssl_ciphers_ = v; | ||
| return *this; | ||
| } | ||
| /// Set the hostname for SSL SNI hostname support. | ||
| client_options& openssl_sni_hostname(string_type const& v) { | ||
| openssl_sni_hostname_ = v; | ||
| return *this; | ||
| } | ||
| /// Set the raw OpenSSL options to use for HTTPS requests. | ||
| client_options& openssl_options(long o) { | ||
| openssl_options_ = o; | ||
| return *this; | ||
| } | ||
| /// Provide an `asio::io_service` hosted in a shared pointer. | ||
| client_options& io_service(std::shared_ptr<asio::io_service> v) { | ||
| io_service_ = v; | ||
| return *this; | ||
| } | ||
| /// Set whether we always verify the peer on the other side of the HTTPS | ||
| /// connection. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This could use a: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Done -- and now changed the default to actually true (!!!?). | ||
| /// | ||
| /// Default: true. | ||
| client_options& always_verify_peer(bool v) { | ||
| always_verify_peer_ = v; | ||
| return *this; | ||
| } | ||
| /// Set an overall timeout for HTTP requests. | ||
| client_options& timeout(int v) { | ||
| timeout_ = v; | ||
| return *this; | ||
308 changes: 28 additions & 280 deletionslibs/network/doc/html/_sources/reference/http_client.txt
Large diffs are not rendered by default.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
9 changes: 2 additions & 7 deletionslibs/network/doc/html/contents.html
This file contains hidden or 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
Binary file modifiedlibs/network/doc/html/objects.inv
Binary file not shown.
3 changes: 1 addition & 2 deletionslibs/network/doc/html/reference.html
This file contains hidden or 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.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.