#include <userver/ugrpc/client/client_settings.hpp>

Detailed Description

Settings relating to creation of a code-generated client.

Definition at line 23 of file client_settings.hpp.

Public Attributes
std::string	client_name

std::string	endpoint

std::optional< std::string >	destination_prefix_in_metrics {std::nullopt}

const dynamic_config::Key< ClientQos > *	client_qos {nullptr}

DedicatedMethodsConfig	dedicated_methods_config {}

Member Data Documentation

◆ client_name

std::string ugrpc::client::ClientSettings::client_name

**(Required)** The name of the client, for diagnostics, credentials and middlewares.

Definition at line 26 of file client_settings.hpp.

◆ client_qos

const dynamic_config::Key<ClientQos>* ugrpc::client::ClientSettings::client_qos {nullptr}

**(Optional)** The name of the QOS dynamic config that will be applied automatically to every RPC.

Timeout from QOS config is ignored if:

an explicit qos parameter is specified at RPC creation, or
deadline is specified in the client_context passed at RPC creation.

Client QOS config definition sample

inline const dynamic_config::Key<ugrpc::client::ClientQos> kUnitTestClientQos{
    "UNIT_TEST_CLIENT_QOS",
    dynamic_config::DefaultAsJsonString{
        R"(
          {
            "methods": {
              "__default__": {
                "timeout-ms": 100
              }
            }
          }
        )",
    },
};

Definition at line 53 of file client_settings.hpp.

◆ dedicated_methods_config

DedicatedMethodsConfig ugrpc::client::ClientSettings::dedicated_methods_config {}

**(Optional)** Dedicated high-load methods that have separate channels

Definition at line 57 of file client_settings.hpp.

◆ destination_prefix_in_metrics

std::optional<std::string> ugrpc::client::ClientSettings::destination_prefix_in_metrics {std::nullopt}

**(Optional)** Prefix for the full destination path in metrics: "destination_prefix_in_metrics/grpc_service/grpc_method". Default: "client(client_name)".

Definition at line 38 of file client_settings.hpp.

◆ endpoint

std::string ugrpc::client::ClientSettings::endpoint

**(Required)** The URI to connect to, e.g. http://my.domain.com:8080. Should not include any HTTP path, just schema, domain name and port. Unix sockets are also supported. For details, see: https://grpc.github.io/grpc/cpp/md_doc_naming.html

Definition at line 33 of file client_settings.hpp.

The documentation for this struct was generated from the following file:

userver/ugrpc/client/client_settings.hpp