MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
uri.hpp
Go to the documentation of this file.
1// Copyright 2009-present MongoDB, Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <memory>
18#include <string>
19#include <vector>
20
22#include <mongocxx/pool-fwd.hpp>
23#include <mongocxx/uri-fwd.hpp>
24
27
31
33
34namespace mongocxx {
35namespace v_noabi {
36
43class uri {
44 public:
46 struct host {
47 std::string name;
48 std::uint16_t port;
49 std::int32_t family;
50 };
51
52 static MONGOCXX_ABI_EXPORT const std::string k_default_uri;
53
65 uri(bsoncxx::v_noabi::string::view_or_value uri_string = k_default_uri);
66
71
75 MONGOCXX_ABI_EXPORT_CDECL(uri&) operator=(uri&&) noexcept;
76
81
82 uri(const uri&) = delete;
83 uri& operator=(const uri&) = delete;
84
91
98
105
112
122 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::view) options() const;
123
130
137
144
151
160
167
174
181
188
194 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<stdx::string_view>) appname() const;
195
201 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<bsoncxx::v_noabi::document::view>)
203
209 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<bsoncxx::v_noabi::document::view>) credentials();
210
216 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) srv_max_hosts() const;
217
224 MONGOCXX_ABI_EXPORT_CDECL(std::vector<stdx::string_view>) compressors() const;
225
231 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) connect_timeout_ms() const;
232
238 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<bool>) direct_connection() const;
239
245 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) heartbeat_frequency_ms() const;
246
252 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) local_threshold_ms() const;
253
259 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) max_pool_size() const;
260
266 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<bool>) retry_reads() const;
267
273 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<bool>) retry_writes() const;
274
281
288
294 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) socket_timeout_ms() const;
295
302
309
315 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<stdx::string_view>) tls_ca_file() const;
316
322 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<stdx::string_view>) tls_certificate_key_file() const;
323
329 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<stdx::string_view>)
331
338 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<bool>)
340
347
353 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<bool>) tls_insecure() const;
354
360 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) wait_queue_timeout_ms() const;
361
367 MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::int32_t>) zlib_compression_level() const;
368
369 private:
370 friend ::mongocxx::v_noabi::client;
371 friend ::mongocxx::v_noabi::pool;
372
373 class impl;
374
375 uri(std::unique_ptr<impl>&& implementation);
376
377 std::unique_ptr<impl> _impl;
378};
379
380} // namespace v_noabi
381} // namespace mongocxx
382
383#include <mongocxx/config/postlude.hpp>
384
Class representing a client connection to MongoDB.
Definition client.hpp:62
Class representing a MongoDB database.
Definition database.hpp:47
A pool of client objects associated with a MongoDB deployment.
Definition pool.hpp:52
A class to represent the read concern. Read concern can be set at the client, database,...
Definition read_concern.hpp:58
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition read_preference.hpp:65
Class representing a MongoDB connection string URI.
Definition uri.hpp:43
stdx::optional< bool > tls_disable_ocsp_endpoint_check() const
Returns the value of the option "tlsDisableOCSPEndpointCheck" if present in the uri.
stdx::optional< stdx::string_view > tls_certificate_key_file_password() const
Returns the value of the option "tlsCertificateKeyFilePassword" if present in the uri.
std::vector< host > hosts() const
Returns the hosts from the uri.
std::string auth_mechanism() const
Returns the authentication mechanism from the uri.
stdx::optional< bool > direct_connection() const
Returns the value of the option "directConnection" if present in the uri.
stdx::optional< std::int32_t > server_selection_timeout_ms() const
Returns the value of the option "serverSelectionTimeoutMS" if present in the uri.
stdx::optional< bool > tls_disable_certificate_revocation_check() const
Returns the value of the option "tlsDisableCertificateRevocationCheck" if present in the uri.
stdx::optional< stdx::string_view > tls_ca_file() const
Returns the value of the option "tlsCAFile" if present in the uri.
stdx::optional< std::int32_t > zlib_compression_level() const
Returns the value of the option "zlibCompressionLevel" if present in the uri.
bool tls() const
Returns the tls parameter from the uri.
stdx::optional< bool > tls_allow_invalid_certificates() const
Returns the value of the option "tlsAllowInvalidCertificates" if present in the uri.
std::string auth_source() const
Returns the authentication source from the uri.
std::string to_string() const
Returns the uri in a string format.
stdx::optional< std::int32_t > heartbeat_frequency_ms() const
Returns the value of the option "heartbeatFrequencyMS" if present in the uri.
bsoncxx::v_noabi::document::view options() const
Returns other uri options.
stdx::optional< bsoncxx::v_noabi::document::view > auth_mechanism_properties() const
Returns the value of the option "authMechanismProperties" if present in the uri.
stdx::optional< bool > server_selection_try_once() const
Returns the value of the option "serverSelectionTryOnce" if present in the uri.
std::vector< stdx::string_view > compressors() const
Returns the list of compressors present in the uri or an empty list if "compressors" was not present ...
stdx::optional< bsoncxx::v_noabi::document::view > credentials()
Returns the value of the option credentials if present in the uri.
MONGOCXX_DEPRECATED bool ssl() const
Returns the ssl parameter from the uri.
std::string username() const
Returns the supplied username from the uri.
stdx::optional< stdx::string_view > appname() const
Returns the value of the option "appname" if present in the uri.
stdx::optional< bool > retry_writes() const
Returns the value of the option "retryWrites" if present in the uri.
stdx::optional< bool > tls_insecure() const
Returns the value of the option "tlsInsecure" if present in the uri.
stdx::optional< std::int32_t > socket_timeout_ms() const
Returns the value of the option "socketTimeoutMS" if present in the uri.
std::string password() const
Returns the password from the uri.
stdx::optional< std::int32_t > local_threshold_ms() const
Returns the value of the option "localThresholdMS" if present in the uri.
stdx::optional< stdx::string_view > tls_certificate_key_file() const
Returns the value of the option "tlsCertificateKeyFile" if present in the uri.
stdx::optional< std::int32_t > srv_max_hosts() const
Returns the value of the option "srvMaxHosts" if present in the uri.
std::string replica_set() const
Returns the replica set specified in the uri.
stdx::optional< std::int32_t > connect_timeout_ms() const
Returns the value of the option "connectTimeoutMS" if present in the uri.
stdx::optional< bool > retry_reads() const
Returns the value of the option "retryReads" if present in the uri.
stdx::optional< std::int32_t > max_pool_size() const
Returns the value of the option "maxPoolSize" if present in the uri.
stdx::optional< bool > tls_allow_invalid_hostnames() const
Returns the value of the option "tlsAllowInvalidHostnames" if present in the uri.
stdx::optional< std::int32_t > wait_queue_timeout_ms() const
Returns the value of the option "waitQueueTimeoutMS" if present in the uri.
Class representing the server-side requirement for reporting the success of a write operation....
Definition write_concern.hpp:61
Declares mongocxx::v_noabi::client.
Provides bsoncxx::v_noabi::document::view.
#define MONGOCXX_DEPRECATED
Declares the associated entity as deprecated.
Definition fwd.hpp:258
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:222
#define MONGOCXX_ABI_EXPORT
Exports the associated entity as part of the ABI.
Definition fwd.hpp:198
The mongocxx macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
The top-level namespace within which all mongocxx library entities are declared.
The top-level namespace reserved for the C++ standard library.
Declares mongocxx::v_noabi::pool.
Provides mongocxx::v_noabi::read_concern.
Provides mongocxx::v_noabi::read_preference.
Provides bsoncxx::v_noabi::string::view_or_value.
A host.
Definition uri.hpp:46
Declares mongocxx::v_noabi::uri.
Provides mongocxx::v_noabi::write_concern.