uri.hpp

Go to the documentation of this file.

// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <memory>
#include <string>
#include <vector>
 
#include <mongocxx/client-fwd.hpp>
#include <mongocxx/pool-fwd.hpp>
#include <mongocxx/uri-fwd.hpp>
 
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/string/view_or_value.hpp>
 
#include <mongocxx/read_concern.hpp>
#include <mongocxx/read_preference.hpp>
#include <mongocxx/write_concern.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
 
class uri {
   public:
    struct host {
        std::string name;
        std::uint16_t port;
        std::int32_t family;
    };
 
    static MONGOCXX_ABI_EXPORT const std::string k_default_uri;
 
    MONGOCXX_ABI_EXPORT_CDECL()
    uri(bsoncxx::v_noabi::string::view_or_value uri_string = k_default_uri);
 
    MONGOCXX_ABI_EXPORT_CDECL() uri(uri&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(uri&) operator=(uri&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() ~uri();
 
    uri(const uri&) = delete;
    uri& operator=(const uri&) = delete;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::string) auth_mechanism() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::string) auth_source() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::vector<host>) hosts() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::string) database() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::view) options() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::string) password() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::read_concern) read_concern() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::read_preference) read_preference() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::string) replica_set() const;
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(bool) ssl() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bool) tls() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::string) to_string() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::string) username() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::write_concern) write_concern() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::stdx::string_view>)
    appname() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view>)
    auth_mechanism_properties() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view>)
    credentials();
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>) srv_max_hosts() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::vector<bsoncxx::v_noabi::stdx::string_view>) compressors() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>)
    connect_timeout_ms() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>) direct_connection() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>)
    heartbeat_frequency_ms() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>)
    local_threshold_ms() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>) max_pool_size() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>) retry_reads() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>) retry_writes() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>)
    server_selection_timeout_ms() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>)
    server_selection_try_once() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>)
    socket_timeout_ms() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>)
    tls_allow_invalid_certificates() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>)
    tls_allow_invalid_hostnames() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::stdx::string_view>)
    tls_ca_file() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::stdx::string_view>)
    tls_certificate_key_file() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::stdx::string_view>)
    tls_certificate_key_file_password() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>)
    tls_disable_certificate_revocation_check() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>)
    tls_disable_ocsp_endpoint_check() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool>) tls_insecure() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>)
    wait_queue_timeout_ms() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t>)
    zlib_compression_level() const;
 
   private:
    friend ::mongocxx::v_noabi::client;
    friend ::mongocxx::v_noabi::pool;
 
    class impl;
 
    uri(std::unique_ptr<impl>&& implementation);
 
    std::unique_ptr<impl> _impl;
};
 
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>