mobile: introduce ClientEngineBuilder class#42997
Closed
wlampert wants to merge 1 commit intoenvoyproxy:mainfrom
Closed
mobile: introduce ClientEngineBuilder class#42997wlampert wants to merge 1 commit intoenvoyproxy:mainfrom
wlampert wants to merge 1 commit intoenvoyproxy:mainfrom
Conversation
variant of the existing EngineBuilder class that provides a more configurable boostrap via its exposed API, but is similarly used to create an engine. The ClientEngineBuilder requires the user to provide their own cluster and route configuration, giving the user more control over the client's behavior. This client is not intended to be used in mobile environments and does not provide support for XDS as of now. Signed-off-by: Will Lampert <wlampert@google.com>
wlampert
requested review from
RyanTheOptimist,
abeyad and
danzh2010
as code owners
danzh2010
reviewed
Jan 14, 2026
Comment on lines
+96
to
+123
| Logger::Logger::Levels log_level_ = Logger::Logger::Levels::info; | ||
| std::unique_ptr<EnvoyLogger> logger_ = nullptr; | ||
| bool enable_logger_ = false; | ||
| std::unique_ptr<EngineCallbacks> callbacks_ = nullptr; | ||
| std::unique_ptr<EnvoyEventTracker> event_tracker_ = nullptr; | ||
|
|
||
| int stream_idle_timeout_seconds_ = 15; | ||
| absl::optional<int> network_thread_priority_ = absl::nullopt; | ||
| absl::optional<size_t> high_watermark_ = absl::nullopt; | ||
|
|
||
| absl::flat_hash_map<std::string, KeyValueStoreSharedPtr> key_value_stores_ = {}; | ||
|
|
||
| std::vector<envoy::extensions::filters::network::http_connection_manager::v3::HttpFilter > hcm_http_filters_ = {}; | ||
| std::vector<envoy::config::cluster::v3::Cluster> clusters_ = {}; | ||
| std::unique_ptr<envoy::config::route::v3::RouteConfiguration> route_configuration_ = nullptr; | ||
| uint32_t per_connection_buffer_limit_bytes_ = 10 * 1024 * 1024; | ||
| std::vector<std::string> stats_prefixes_ = {}; | ||
| std::optional<envoy::config::bootstrap::v3::Watchdogs> watchdog_ = std::nullopt; | ||
| std::optional<envoy::extensions::filters::http::router::v3::Router> router_config_ = std::nullopt; | ||
|
|
||
| std::vector<std::pair<std::string, bool>> runtime_guards_ = {}; | ||
| std::vector<std::pair<std::string, bool>> restart_runtime_guards_ = {}; | ||
| absl::flat_hash_map<std::string, StringAccessorSharedPtr> string_accessors_ = {}; | ||
|
|
||
| std::string node_id_ = ""; | ||
| absl::optional<NodeLocality> node_locality_ = absl::nullopt; | ||
| absl::optional<Protobuf::Struct> node_metadata_ = absl::nullopt; | ||
| bool enable_stats_collection_ = false; |
Contributor
There was a problem hiding this comment.
Some of these knobes are already present in the common engine builder. I'm wondering if we can extend that engine builder's config generation part instead of writer a new engine builder.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Commit Message: This PR introduces a new ClientEngineBuilder class. This class is a variant of the existing EngineBuilder class that provides a more configurable bootstrap via its exposed API but is similarly used to create an engine. The ClientEngineBuilder requires the user to provide their own cluster and route configuration, giving the user more control over the client's behavior. This client is not intended to be used in mobile environments and does not provide support for XDS as of now.
Additional Description: N/A
Risk Level: Low - this is a new, separate client and should not affect Envoy or Envoy Mobile.
Testing: Unit and integration are included in this PR. I also conducted manual testing using the client in a staging environment to send requests to an Envoy Server.
Docs Changes: N/A
Release Notes: N/A
Platform Specific Features: N/A